Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/):
Copy link
Contributor

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?


```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
Copy link
Contributor

Choose a reason for hiding this comment

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

This implies a mixture of uv pip and pip. Does that work as expected?

Should we just push people to uv pip.

>
> 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>`.

Expand Down Expand Up @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ docling = [
"docling>=2.45.0",
]

all = ["mellea[watsonx,docling,hf]"]
Copy link
Contributor

Choose a reason for hiding this comment

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

sweet thanks :)


[dependency-groups]
# Use these like:
# pip install -e . --group dev
Expand Down
Loading