Skip to content

Commit b1807ae

Browse files
authored
Adding additional guidance in readme for installations (#79)
1 parent f0bb0c2 commit b1807ae

File tree

3 files changed

+2513
-2469
lines changed

3 files changed

+2513
-2469
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,30 @@ You can get started with a local install, or by using Colab notebooks.
4747

4848
<img src="https://github.com/generative-computing/mellea/raw/main/docs/GetStarted_py.png" style="max-width:800px">
4949

50-
Install with pip:
50+
Install with [uv](https://docs.astral.sh/uv/getting-started/installation/):
5151

5252
```bash
5353
uv pip install mellea
5454
```
5555

56+
Install with pip:
57+
58+
```bash
59+
pip install mellea
60+
```
61+
62+
> [!NOTE]
63+
> `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:
64+
>
65+
> ```bash
66+
> uv pip install mellea[hf] # for Huggingface extras and Alora capabilities.
67+
> uv pip install mellea[watsonx] # for watsonx backend
68+
> uv pip install mellea[docling] # for docling
69+
> uv pip install mellea[all] # for all the optional dependencies
70+
> ```
71+
>
72+
> You can also install all the optional dependencies with `uv sync --all-extras`
73+
5674
> [!NOTE]
5775
> 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>`.
5876
@@ -110,7 +128,19 @@ uv venv .venv && source .venv/bin/activate
110128
Use `uv pip` to install from source with the editable flag:
111129
112130
```bash
113-
uv pip install -e .
131+
uv pip install -e .[all]
132+
```
133+
134+
If you are planning to contribute to the repo, it would be good to have all the development requirements installed:
135+
136+
```bash
137+
uv pip install .[all] --group dev --group notebook --group docs
138+
```
139+
140+
or
141+
142+
```bash
143+
uv sync --all-extras --all-groups
114144
```
115145
116146
Ensure that you install the precommit hooks:

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ docling = [
6767
"docling>=2.45.0",
6868
]
6969

70+
all = ["mellea[watsonx,docling,hf]"]
71+
7072
[dependency-groups]
7173
# Use these like:
7274
# pip install -e . --group dev

0 commit comments

Comments
 (0)