Adding additional guidance in readme for installations #79
Conversation
This file contains hidden or 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
nrfulton
approved these changes
Aug 20, 2025
Comment on lines
+56
to
+70
| Install with pip: | ||
|
|
||
| ```bash | ||
| pip install mellea | ||
| ``` | ||
|
|
||
| > [!NOTE] | ||
| > `mellea` comes with some additional packages as defined in our `pyproject.toml`. I you would like to install all the extra optional dependencies, please run the following commands: | ||
| > | ||
| > ```bash | ||
| > uv pip install mellea[hf] # for Huggingface extras and Alora capabilities. | ||
| > uv pip install mellea[watsonx] # for watsonx backend | ||
| > uv pip install mellea[docling] # for docling | ||
| > uv pip install mellea[all] # for all the optional dependencies | ||
| > ``` |
Contributor
There was a problem hiding this comment.
This implies a mixture of uv pip and pip. Does that work as expected?
Should we just push people to uv pip.
| <img src="https://github.com/generative-computing/mellea/raw/main/docs/GetStarted_py.png" style="max-width:800px"> | ||
|
|
||
| Install with pip: | ||
| Install with [uv](https://docs.astral.sh/uv/getting-started/installation/): |
Contributor
There was a problem hiding this comment.
Instead of "building it up" in a tutorial fashion, should the first command just give you something that would work out of the box for all the examples in the tutorial and only then delve into the details?
| "docling>=2.45.0", | ||
| ] | ||
|
|
||
| all = ["mellea[watsonx,docling,hf]"] |
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.