-
Notifications
You must be signed in to change notification settings - Fork 49
Adding additional guidance in readme for installations #79
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,12 +47,30 @@ You can get started with a local install, or by using Colab notebooks. | |
|
|
||
| <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/): | ||
|
|
||
| ```bash | ||
| uv pip install mellea | ||
| ``` | ||
|
|
||
| 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 | ||
| > ``` | ||
|
Comment on lines
+56
to
+70
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This implies a mixture of Should we just push people to |
||
| > | ||
| > You can also install all the optional dependencies with `uv sync --all-extras` | ||
|
|
||
| > [!NOTE] | ||
| > If running on an Intel mac, you may get errors related to torch/torchvision versions. Conda maintains updated versions of these packages. You will need to create a conda environment and run `conda install 'torchvision>=0.22.0'` (this should also install pytorch and torchvision-extra). Then, you should be able to run `uv pip install mellea`. To run the examples, you will need to use `python <filename>` inside the conda environment instead of `uv run --with mellea <filename>`. | ||
|
|
||
|
|
@@ -110,7 +128,19 @@ uv venv .venv && source .venv/bin/activate | |
| Use `uv pip` to install from source with the editable flag: | ||
|
|
||
| ```bash | ||
| uv pip install -e . | ||
| uv pip install -e .[all] | ||
| ``` | ||
|
|
||
| If you are planning to contribute to the repo, it would be good to have all the development requirements installed: | ||
|
|
||
| ```bash | ||
| uv pip install .[all] --group dev --group notebook --group docs | ||
| ``` | ||
|
|
||
| or | ||
|
|
||
| ```bash | ||
| uv sync --all-extras --all-groups | ||
| ``` | ||
|
|
||
| Ensure that you install the precommit hooks: | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -67,6 +67,8 @@ docling = [ | |
| "docling>=2.45.0", | ||
| ] | ||
|
|
||
| all = ["mellea[watsonx,docling,hf]"] | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. sweet thanks :) |
||
|
|
||
| [dependency-groups] | ||
| # Use these like: | ||
| # pip install -e . --group dev | ||
|
|
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?