Specify optional dependencies for shortfin_apps #513
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ScottTodd
approved these changes
Nov 14, 2024
Comment on lines
+37
to
+42
| [project.optional-dependencies] | ||
| apps = [ | ||
| "transformers", | ||
| "dataclasses-json", | ||
| "pillow", | ||
| ] |
There was a problem hiding this comment.
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]
Comment on lines
+33
to
+35
| apps = [ | ||
| "shortfin[apps]", | ||
| ] |
There was a problem hiding this comment.
We also considered other names for extras (docs here: https://packaging.python.org/en/latest/specifications/dependency-specifiers/#extras).
sdorsdxl: 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. Thetransformers,dataclasses-json, andpillowdependencies here aren't specific to SDXL either - they are generic ML / data / image librariesexamplesordemos: these suggest a lower support level thanappsapps: this matches the code path and will let us eventually include other deps for other apps. We can later add more specific extras ifappsgets too large
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.