Adapt to repository rename from SHARK-Platform to shark-ai. (#545)

nod-ai · Nov 15, 2024 · d83ab9d · d83ab9d
1 parent 8664abe
commit d83ab9d
Show file tree

Hide file tree

Showing 21 changed files with 62 additions and 62 deletions.
diff --git a/.github/workflows/build_packages.yml b/.github/workflows/build_packages.yml
@@ -129,7 +129,7 @@ jobs:
         token: "${{ secrets.RELEASE_PUBLISH_ACCESS_TOKEN }}"
         tag: "dev-wheels"
         name: "dev-wheels"
-        body: "Automatic snapshot release of SHARK-Platform python wheels."
+        body: "Automatic snapshot release of shark-ai python wheels."
         removeArtifacts: false
         allowUpdates: true
         replacesArtifacts: true

diff --git a/.github/workflows/ci-shark-platform.yml → .github/workflows/ci-shark-ai.yml b/.github/workflows/ci-shark-platform.yml → .github/workflows/ci-shark-ai.yml
@@ -4,7 +4,7 @@
 # See https://llvm.org/LICENSE.txt for license information.
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
-name: CI - shark-platform
+name: CI - shark-ai
 
 on:
   workflow_dispatch:

diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-# SHARK Modeling and Serving Libraries
+# shark-ai: SHARK Modeling and Serving Libraries
 
 > [!IMPORTANT]
 > Development is still in progress for several project components. See the
 > notes below for which workflows are best supported.
 
-![GitHub License](https://img.shields.io/github/license/nod-ai/SHARK-Platform)
+![GitHub License](https://img.shields.io/github/license/nod-ai/shark-ai)
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 
 <!-- TODO: high level overview, features when components are used together -->
@@ -15,7 +15,7 @@
 
 <!-- TODO: features list here? -->
 
-[![PyPI version](https://badge.fury.io/py/shortfin.svg)](https://badge.fury.io/py/shortfin) [![CI - shortfin](https://github.com/nod-ai/SHARK-Platform/actions/workflows/ci_linux_x64-libshortfin.yml/badge.svg?event=push)](https://github.com/nod-ai/SHARK-Platform/actions/workflows/ci_linux_x64-libshortfin.yml?query=event%3Apush)
+[![PyPI version](https://badge.fury.io/py/shortfin.svg)](https://badge.fury.io/py/shortfin) [![CI - shortfin](https://github.com/nod-ai/shark-ai/actions/workflows/ci_linux_x64-libshortfin.yml/badge.svg?event=push)](https://github.com/nod-ai/shark-ai/actions/workflows/ci_linux_x64-libshortfin.yml?query=event%3Apush)
 
 The shortfin sub-project is SHARK's high performance inference library and
 serving engine.
@@ -25,7 +25,7 @@ serving engine.
 
 ### [`sharktank/`](./sharktank/)
 
-[![PyPI version](https://badge.fury.io/py/sharktank.svg)](https://badge.fury.io/py/sharktank) [![CI - sharktank](https://github.com/nod-ai/SHARK-Platform/actions/workflows/ci-sharktank.yml/badge.svg?event=push)](https://github.com/nod-ai/SHARK-Platform/actions/workflows/ci-sharktank.yml?query=event%3Apush)
+[![PyPI version](https://badge.fury.io/py/sharktank.svg)](https://badge.fury.io/py/sharktank) [![CI - sharktank](https://github.com/nod-ai/shark-ai/actions/workflows/ci-sharktank.yml/badge.svg?event=push)](https://github.com/nod-ai/shark-ai/actions/workflows/ci-sharktank.yml?query=event%3Apush)
 
 The SHARK Tank sub-project contains a collection of model recipes and
 conversion tools to produce inference-optimized programs.
@@ -45,7 +45,7 @@ conversion tools to produce inference-optimized programs.
 
 ### [`tuner/`](./tuner/)
 
-[![CI - Tuner](https://github.com/nod-ai/SHARK-Platform/actions/workflows/ci-tuner.yml/badge.svg?event=push)](https://github.com/nod-ai/SHARK-Platform/actions/workflows/ci-tuner.yml?query=event%3Apush)
+[![CI - Tuner](https://github.com/nod-ai/shark-ai/actions/workflows/ci-tuner.yml/badge.svg?event=push)](https://github.com/nod-ai/shark-ai/actions/workflows/ci-tuner.yml?query=event%3Apush)
 
 The Tuner sub-project assists with tuning program performance by searching for
 optimal parameter configurations to use during model compilation.
@@ -63,8 +63,8 @@ optimal parameter configurations to use during model compilation.
 
 Model name | Model recipes | Serving apps
 ---------- | ------------- | ------------
-SDXL       | [`sharktank/sharktank/models/punet/`](https://github.com/nod-ai/SHARK-Platform/tree/main/sharktank/sharktank/models/punet) | [`shortfin/python/shortfin_apps/sd/`](https://github.com/nod-ai/SHARK-Platform/tree/main/shortfin/python/shortfin_apps/sd)
-llama      | [`sharktank/sharktank/models/llama/`](https://github.com/nod-ai/SHARK-Platform/tree/main/sharktank/sharktank/models/llama) | [`shortfin/python/shortfin_apps/llm/`](https://github.com/nod-ai/SHARK-Platform/tree/main/shortfin/python/shortfin_apps/llm)
+SDXL       | [`sharktank/sharktank/models/punet/`](https://github.com/nod-ai/shark-ai/tree/main/sharktank/sharktank/models/punet) | [`shortfin/python/shortfin_apps/sd/`](https://github.com/nod-ai/shark-ai/tree/main/shortfin/python/shortfin_apps/sd)
+llama      | [`sharktank/sharktank/models/llama/`](https://github.com/nod-ai/shark-ai/tree/main/sharktank/sharktank/models/llama) | [`shortfin/python/shortfin_apps/llm/`](https://github.com/nod-ai/shark-ai/tree/main/shortfin/python/shortfin_apps/llm)
 
 
 ## SHARK Users

diff --git a/build_tools/python_deploy/pypi_deploy.sh b/build_tools/python_deploy/pypi_deploy.sh
@@ -21,7 +21,7 @@
 #     python3.13t -m ensurepip --upgrade
 #     ```
 #   * Choose a release candidate to promote from
-#     https://github.com/nod-ai/SHARK-Platform/releases/tag/dev-wheels
+#     https://github.com/nod-ai/shark-ai/releases/tag/dev-wheels
 #
 # Usage:
 #   ./pypi_deploy.sh 2.9.0rc20241108
@@ -33,7 +33,7 @@ RELEASE="$1"
 SCRIPT_DIR="$(dirname -- "$( readlink -f -- "$0"; )")";
 REPO_ROOT="$(cd "$SCRIPT_DIR"/../../ && pwd)"
 TMPDIR="$(mktemp --directory --tmpdir shark_platform_pypi_wheels.XXXXX)"
-ASSETS_PAGE="https://github.com/nod-ai/SHARK-Platform/releases/expanded_assets/dev-wheels"
+ASSETS_PAGE="https://github.com/nod-ai/shark-ai/releases/expanded_assets/dev-wheels"
 
 # TODO: rewrite in Python?
 

diff --git a/docs/model_cookbook.md b/docs/model_cookbook.md
@@ -1,6 +1,6 @@
 # Model cookbook
 
-Note: These are early notes and commands that the SHARK-Platform team is using
+Note: These are early notes and commands that the shark-ai team is using
 and will turn into proper docs later.
 
 ## Diagrams

diff --git a/docs/nightly_releases.md b/docs/nightly_releases.md
@@ -2,19 +2,19 @@
 
 > [!WARNING]
 > This is still under development! See
-> https://github.com/nod-ai/SHARK-Platform/issues/400.
+> https://github.com/nod-ai/shark-ai/issues/400.
 >
 > These instructions will be converted into a user guide once stable packages
-> are published to PyPI: <https://github.com/nod-ai/SHARK-Platform/issues/359>.
+> are published to PyPI: <https://github.com/nod-ai/shark-ai/issues/359>.
 
 Nightly releases are uploaded to
-https://github.com/nod-ai/SHARK-Platform/releases/tag/dev-wheels.
+https://github.com/nod-ai/shark-ai/releases/tag/dev-wheels.
 
 * The "expanded_assets" version of a release page is compatible with the
   `-f, --find-links <url>` options of `pip install`
   ([docs here](https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-f)).
   For the "dev-wheels" release above, that page is:
-  <https://github.com/nod-ai/SHARK-Platform/releases/expanded_assets/dev-wheels>
+  <https://github.com/nod-ai/shark-ai/releases/expanded_assets/dev-wheels>
 * These releases are generated using
   [`.github/workflows/build_package.yml`](../.github/workflows/build_packages.yml)
 * That workflow runs the
@@ -23,7 +23,7 @@ https://github.com/nod-ai/SHARK-Platform/releases/tag/dev-wheels.
 [`shortfin/build_tools/build_linux_package.sh`](../shortfin/build_tools/build_linux_package.sh)
   scripts
 * Workflow history can be viewed at
-  <https://github.com/nod-ai/SHARK-Platform/actions/workflows/build_packages.yml>
+  <https://github.com/nod-ai/shark-ai/actions/workflows/build_packages.yml>
 
 ## Prerequisites
 
@@ -38,7 +38,7 @@ source builds.
 You will need a recent version of Python.
 
 * As of Nov 1, 2024, sharktank is compatible with Python 3.11. See
-  https://github.com/nod-ai/SHARK-Platform/issues/349 for Python 3.12 support.
+  https://github.com/nod-ai/shark-ai/issues/349 for Python 3.12 support.
 * As of Nov 4, 2024, shortfin publishes packages for Python 3.11, 3.12, 3.13,
   and 3.13t
 
@@ -67,7 +67,7 @@ python3.11 -m venv 3.11.venv
 source 3.11.venv/bin/activate
 
 # Install 'sharktank' package from nightly releases.
-pip install sharktank -f https://github.com/nod-ai/SHARK-Platform/releases/expanded_assets/dev-wheels
+pip install sharktank -f https://github.com/nod-ai/shark-ai/releases/expanded_assets/dev-wheels
 
 # Test the installation.
 python -c "from sharktank import ops; print('Sanity check passed')"
@@ -84,7 +84,7 @@ python3.11 -m venv 3.11.venv
 source 3.11.venv/bin/activate
 
 # Install 'shortfin' package from nightly releases.
-pip install shortfin -f https://github.com/nod-ai/SHARK-Platform/releases/expanded_assets/dev-wheels
+pip install shortfin -f https://github.com/nod-ai/shark-ai/releases/expanded_assets/dev-wheels
 
 # Test the installation.
 python -c "import shortfin as sf; print('Sanity check passed')"