Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1607

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update README.md #1607

wants to merge 1 commit into from

Conversation

karan-kankariya
Copy link

Cleaned up installation guides

Cleaned up installation guides
Copy link
Collaborator

@monorimet monorimet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, there are a few parts that could use updating but this reads better and doesn't hide macos/linux instructions which is good.

@@ -1,129 +1,114 @@
# SHARK

High Performance Machine Learning Distribution
SHARK is a high performarce machine learning distribution that is built on LLVM, MLIR, OpenXLA’s IREE and nod.ai’s tuning.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo

### Prerequisites
* Install Python 3.11
#### MacOS Drivers
* Install the 1.3.216 Vulkan SDK from [here](https://sdk.lunarg.com/sdk/download/1.3.216.0/mac/vulkansdk-macos-1.3.216.0.dmg). Note: Newer versions of the SDK will not work.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We no longer need this. We have the Metal backend.

@cqtqlyst
Copy link

would adding hardware prerequisites especially for windows & linux be useful?

#### Install your Windows hardware drivers
### Installation

Install Windows Hardware Drivers
* [AMD RDNA Users] Download the latest driver [here](https://www.amd.com/en/support/kb/release-notes/rn-rad-win-23-2-1).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that MLIR/IREE support is integrated into the mainline drivers, I think its a bit problematic to link to a particular driver version as the 'latest', as we're not set up to keep updating to link to be to the actual latest one.

Maybe we should just say > 23.2.1 and link to the main AMD support page at https://www.amd.com/en/support

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants