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.

Sign up for GitHub

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

Jump to bottom

Specify optional dependencies for shortfin_apps #513

Merged
merged 2 commits into from
Nov 14, 2024
Merged

Specify optional dependencies for shortfin_apps #513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7365b0b
Specify optional dependencies for shortfin_apps
marbre Nov 14, 2024
0573479
Merge branch 'main' into shortfin-deps
marbre Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions shark-ai/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ Repository = "https://github.com/nod-ai/SHARK-Platform"
onnx = [
"iree-base-compiler[onnx]",
]
apps = [
"shortfin[apps]",
]
Comment on lines +33 to +35
Copy link
Member

Choose a reason for hiding this comment

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

We also considered other names for extras (docs here: https://packaging.python.org/en/latest/specifications/dependency-specifiers/#extras).

  • sd or sdxl: these are very specific, but we don't want to have an extra for every model (sd3, llama2, llama3, flux, etc.), unless there is good reason for that. The transformers, dataclasses-json, and pillow dependencies here aren't specific to SDXL either - they are generic ML / data / image libraries
  • examples or demos: these suggest a lower support level than apps
  • apps: this matches the code path and will let us eventually include other deps for other apps. We can later add more specific extras if apps gets too large


[tool.setuptools]
packages = []
Expand Down
7 changes: 7 additions & 0 deletions shortfin/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,13 @@ dynamic = ["version"]
Repository = "https://github.com/nod-ai/SHARK-Platform"
Documentation = "https://shortfin.readthedocs.io/en/latest/"

[project.optional-dependencies]
apps = [
"transformers",
"dataclasses-json",
"pillow",
]
Comment on lines +37 to +42
Copy link
Member

Choose a reason for hiding this comment

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

This will allow us to simplify the setup instructions https://github.com/nod-ai/SHARK-Platform/blob/3e7429544fd81938e2b1c0d8fbb098b1c871ecf7/shortfin/python/shortfin_apps/sd/README.md?plain=1#L6-L15

to just one of these:

pip install shortfin[apps]
pip install shark-ai[apps]


[tool.pytest.ini_options]
addopts = [
"-ra",
Expand Down
Loading