Skip to content

Commit

Permalink
Update links after repository renamings (#2174)
Browse files Browse the repository at this point in the history
  • Loading branch information
marbre authored Oct 17, 2024
1 parent ec75e08 commit 6b79037
Show file tree
Hide file tree
Showing 13 changed files with 23 additions and 23 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

High Performance Machine Learning Distribution

*We are currently rebuilding SHARK to take advantage of [Turbine](https://github.com/nod-ai/SHARK-Turbine). Until that is complete make sure you use an .exe release or a checkout of the `SHARK-1.0` branch, for a working SHARK*
*We are currently rebuilding SHARK to take advantage of [Turbine](https://github.com/iree-org/iree-turbine). Until that is complete make sure you use an .exe release or a checkout of the `SHARK-1.0` branch, for a working SHARK*

[![Nightly Release](https://github.com/nod-ai/SHARK/actions/workflows/nightly.yml/badge.svg)](https://github.com/nod-ai/SHARK/actions/workflows/nightly.yml)
[![Validate torch-models on Shark Runtime](https://github.com/nod-ai/SHARK/actions/workflows/test-models.yml/badge.svg)](https://github.com/nod-ai/SHARK/actions/workflows/test-models.yml)
[![Nightly Release](https://github.com/nod-ai/SHARK-Studio/actions/workflows/nightly.yml/badge.svg)](https://github.com/nod-ai/SHARK-Studio/actions/workflows/nightly.yml)
[![Validate torch-models on Shark Runtime](https://github.com/nod-ai/SHARK-Studio/actions/workflows/test-models.yml/badge.svg)](https://github.com/nod-ai/SHARK-Studio/actions/workflows/test-models.yml)


<details>
Expand All @@ -27,9 +27,9 @@ Other users please ensure you have your latest vendor drivers and Vulkan SDK fro

### Quick Start for SHARK Stable Diffusion for Windows 10/11 Users

Install the Driver from (Prerequisites)[https://github.com/nod-ai/SHARK#install-your-hardware-drivers] above
Install the Driver from (Prerequisites)[https://github.com/nod-ai/SHARK-Studio#install-your-hardware-drivers] above

Download the [stable release](https://github.com/nod-ai/shark/releases/latest) or the most recent [SHARK 1.0 pre-release](https://github.com/nod-ai/shark/releases).
Download the [stable release](https://github.com/nod-ai/SHARK-Studio/releases/latest) or the most recent [SHARK 1.0 pre-release](https://github.com/nod-ai/SHARK-Studio/releases).

Double click the .exe, or [run from the command line](#running) (recommended), and you should have the [UI](http://localhost:8080/) in the browser.

Expand Down Expand Up @@ -73,7 +73,7 @@ cd SHARK

## Switch to the Correct Branch (IMPORTANT!)

Currently SHARK is being rebuilt for [Turbine](https://github.com/nod-ai/SHARK-Turbine) on the `main` branch. For now you are strongly discouraged from using `main` unless you are working on the rebuild effort, and should not expect the code there to produce a working application for Image Generation, So for now you'll need switch over to the `SHARK-1.0` branch and use the stable code.
Currently SHARK is being rebuilt for [Turbine](https://github.com/iree-org/iree-turbine) on the `main` branch. For now you are strongly discouraged from using `main` unless you are working on the rebuild effort, and should not expect the code there to produce a working application for Image Generation, So for now you'll need switch over to the `SHARK-1.0` branch and use the stable code.

```shell
git checkout SHARK-1.0
Expand Down Expand Up @@ -358,12 +358,12 @@ SHARK is maintained to support the latest innovations in ML Models:
| Vision Transformer | :green_heart: | :green_heart: | :green_heart: |
| ResNet50 | :green_heart: | :green_heart: | :green_heart: |

For a complete list of the models supported in SHARK, please refer to [tank/README.md](https://github.com/nod-ai/SHARK/blob/main/tank/README.md).
For a complete list of the models supported in SHARK, please refer to [tank/README.md](https://github.com/nod-ai/SHARK-Studio/blob/main/tank/README.md).

## Communication Channels

* [SHARK Discord server](https://discord.gg/RUqY2h2s9u): Real time discussions with the SHARK team and other users
* [GitHub issues](https://github.com/nod-ai/SHARK/issues): Feature requests, bugs etc
* [GitHub issues](https://github.com/nod-ai/SHARK-Studio/issues): Feature requests, bugs etc

## Related Projects

Expand Down
2 changes: 1 addition & 1 deletion apps/shark_studio/api/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ def get_rocm_target_chip(device_str):
if key in device_str:
return rocm_chip_map[key]
raise AssertionError(
f"Device {device_str} not recognized. Please file an issue at https://github.com/nod-ai/SHARK/issues."
f"Device {device_str} not recognized. Please file an issue at https://github.com/nod-ai/SHARK-Studio/issues."
)


Expand Down
4 changes: 2 additions & 2 deletions docs/shark_iree_profiling.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Overview

This document is intended to provide a starting point for profiling with SHARK/IREE. At it's core
[SHARK](https://github.com/nod-ai/SHARK/tree/main/tank) is a python API that links the MLIR lowerings from various
[SHARK](https://github.com/nod-ai/SHARK-Studio/tree/main/tank) is a python API that links the MLIR lowerings from various
frameworks + frontends (e.g. PyTorch -> Torch-MLIR) with the compiler + runtime offered by IREE. More information
on model coverage and framework support can be found [here](https://github.com/nod-ai/SHARK/tree/main/tank). The intended
on model coverage and framework support can be found [here](https://github.com/nod-ai/SHARK-Studio/tree/main/tank). The intended
use case for SHARK is for compilation and deployment of performant state of the art AI models.

![image](https://user-images.githubusercontent.com/22101546/217151219-9bb184a3-cfb9-4788-bb7e-5b502953525c.png)
Expand Down
2 changes: 1 addition & 1 deletion docs/shark_sd_blender.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ We currently make use of the [AI-Render Plugin](https://github.com/benrugg/AI-Re

## Setup SHARK and prerequisites:

* Download the latest SHARK SD webui .exe from [here](https://github.com/nod-ai/SHARK/releases) or follow instructions on the [README](https://github.com/nod-ai/SHARK#readme)
* Download the latest SHARK SD webui .exe from [here](https://github.com/nod-ai/SHARK-Studio/releases) or follow instructions on the [README](https://github.com/nod-ai/SHARK-Studio#readme)
* Once you have the .exe where you would like SHARK to install, run the .exe from terminal/PowerShell with the `--api` flag:
```
## Run the .exe in API mode:
Expand Down
4 changes: 2 additions & 2 deletions docs/shark_sd_koboldcpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ This does mean however, that on a brand new fresh install of SHARK that has not

## Setup SHARK and prerequisites:

* Make sure you have suitable drivers for your graphics card installed. See the prerequisties section of the [README](https://github.com/nod-ai/SHARK#readme).
* Download the latest SHARK studio .exe from [here](https://github.com/nod-ai/SHARK/releases) or follow the instructions in the [README](https://github.com/nod-ai/SHARK#readme) for an advanced, Linux or Mac install.
* Make sure you have suitable drivers for your graphics card installed. See the prerequisties section of the [README](https://github.com/nod-ai/SHARK-Studio#readme).
* Download the latest SHARK studio .exe from [here](https://github.com/nod-ai/SHARK-Studio/releases) or follow the instructions in the [README](https://github.com/nod-ai/SHARK-Studio#readme) for an advanced, Linux or Mac install.
* Run SHARK from terminal/PowerShell with the `--api` flag. Since koboldcpp also expects both CORS support and the image generator to be running on port `7860` rather than SHARK default of `8080`, also include both the `--api_accept_origin` flag with a suitable origin (use `="*"` to enable all origins) and `--server_port=7860` on the command line. (See the if you want to run SHARK on a different port)

```powershell
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ wheel

torch==2.3.0
shark-turbine @ git+https://github.com/iree-org/iree-turbine.git@main
turbine-models @ git+https://github.com/nod-ai/SHARK-Turbine.git@main#subdirectory=models
turbine-models @ git+https://github.com/nod-ai/SHARK-ModelDev.git@main#subdirectory=models
diffusers @ git+https://github.com/nod-ai/[email protected]
brevitas @ git+https://github.com/Xilinx/brevitas.git@6695e8df7f6a2c7715b9ed69c4b78157376bb60b

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
long_description_content_type="text/markdown",
project_urls={
"Code": "https://github.com/nod-ai/SHARK",
"Bug Tracker": "https://github.com/nod-ai/SHARK/issues",
"Bug Tracker": "https://github.com/nod-ai/SHARK-Studio/issues",
},
classifiers=[
"Programming Language :: Python :: 3",
Expand Down
2 changes: 1 addition & 1 deletion shark/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ def shark(model, inputs, *, options):
log.exception(
"Unable to import SHARK - High Performance Machine Learning Distribution"
"Please install the right version of SHARK that matches the PyTorch version being used. "
"Refer to https://github.com/nod-ai/SHARK/ for details."
"Refer to https://github.com/nod-ai/SHARK-Studio/ for details."
)
raise
return SharkBackend(model, inputs, options)
Expand Down
2 changes: 1 addition & 1 deletion shark/examples/shark_training/stable_diffusion/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pip install accelerate transformers ftfy

Please cherry-pick this branch of torch-mlir: https://github.com/vivekkhandelwal1/torch-mlir/tree/sd-ops
and build it locally. You can find the instructions for using locally build Torch-MLIR,
here: https://github.com/nod-ai/SHARK#how-to-use-your-locally-built-iree--torch-mlir-with-shark
here: https://github.com/nod-ai/SHARK-Studio#how-to-use-your-locally-built-iree--torch-mlir-with-shark

## Run the Stable diffusion fine tuning

Expand Down
2 changes: 1 addition & 1 deletion shark/iree_utils/_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ def device_driver_info(device):
f"Required drivers for {device} not found. {device_driver_err_map[device]['debug']} "
f"Please install the required drivers{device_driver_err_map[device]['solution']} "
f"For further assistance please reach out to the community on discord [https://discord.com/invite/RUqY2h2s9u]"
f" and/or file a bug at https://github.com/nod-ai/SHARK/issues"
f" and/or file a bug at https://github.com/nod-ai/SHARK-Studio/issues"
)
return err_msg
else:
Expand Down
2 changes: 1 addition & 1 deletion tank/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ For more information refer to [MODEL TRACKING SHEET](https://docs.google.com/spr

### Run all model tests on CPU/GPU/VULKAN/Metal

For a list of models included in our pytest model suite, see https://github.com/nod-ai/SHARK/blob/main/tank/all_models.csv
For a list of models included in our pytest model suite, see https://github.com/nod-ai/SHARK-Studio/blob/main/tank/all_models.csv

```shell
pytest tank/test_models.py
Expand Down
2 changes: 1 addition & 1 deletion tank/generate_sharktank.py
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ def is_valid_file(arg):
# type=lambda x: is_valid_file(x),
# default="./tank/torch_model_list.csv",
# help="""Contains the file with torch_model name and args.
# Please see: https://github.com/nod-ai/SHARK/blob/main/tank/torch_model_list.csv""",
# Please see: https://github.com/nod-ai/SHARK-Studio/blob/main/tank/torch_model_list.csv""",
# )
# parser.add_argument(
# "--ci_tank_dir",
Expand Down
4 changes: 2 additions & 2 deletions tank/test_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ def test_module(self, dynamic, device, config):
and device == "rocm"
):
pytest.xfail(
reason="iree-compile buffer limit issue: https://github.com/nod-ai/SHARK/issues/475"
reason="iree-compile buffer limit issue: https://github.com/nod-ai/SHARK-Studio/issues/475"
)
if (
config["model_name"]
Expand All @@ -407,7 +407,7 @@ def test_module(self, dynamic, device, config):
and device == "rocm"
):
pytest.xfail(
reason="Numerics issues: https://github.com/nod-ai/SHARK/issues/476"
reason="Numerics issues: https://github.com/nod-ai/SHARK-Studio/issues/476"
)
if config["framework"] == "tf" and self.module_tester.batch_size != 1:
pytest.xfail(
Expand Down

0 comments on commit 6b79037

Please sign in to comment.