Skip to content

Commit 63ffc39

Browse files
authored
update install commands (#11)
1 parent e134411 commit 63ffc39

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ uv pip install mellea
5454
```
5555

5656
> [!NOTE]
57-
> 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 .`. To run the examples, you will need to use `python <filename>` inside the conda environment instead of `uv run --with mellea <filename>`.
57+
> 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>`.
5858
5959
> [!NOTE]
6060
> If you are using python >= 3.13, you may encounter an issue where outlines cannot be installed due to rust compiler issues (`error: can't find Rust compiler`). You can either downgrade to python 3.12 or install the [rust compiler](https://www.rust-lang.org/tools/install) to build the wheel for outlines locally.
@@ -70,7 +70,8 @@ print(m.chat("What is the etymology of mellea?").content)
7070

7171

7272
Then run it:
73-
> NOTE: Before we get started, you will need to download and install [ollama](https://ollama.com/). Mellea can work with many different types of backends, but everything in this tutorial will "just work" on a Macbook running IBM's Granite 3.3 8B model.
73+
> [!NOTE]
74+
> Before we get started, you will need to download and install [ollama](https://ollama.com/). Mellea can work with many different types of backends, but everything in this tutorial will "just work" on a Macbook running IBM's Granite 3.3 8B model.
7475
```shell
7576
uv run --with mellea docs/examples/tutorial/example.py
7677
```

docs/alora.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Mellea provides a command-line interface for training and uploading [LoRA](https
99
From the root of the repository:
1010

1111
```bash
12-
pip install -e .
12+
pip install mellea
1313
huggingface-cli login # Optional: only needed for uploads
1414
```
1515

@@ -82,7 +82,7 @@ This will:
8282
## 🛠 Requirements
8383

8484
- Python 3.8+
85-
- Install the following dependencies manually or via `pip install -e .`:
85+
- Install the following dependencies manually or via `pip install mellea`:
8686
- `transformers`
8787
- `trl`
8888
- `peft`

docs/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ We also recommend that you download and install [uv](https://docs.astral.sh/uv/#
5656
uv run example_name.py --with mellea
5757
```
5858
> [!NOTE]
59-
> 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 .`. To run the examples, you will need to use `python <filename>` inside the conda environment instead of `uv run --with mellea <filename>`.
59+
> 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>`.
6060
6161
> [!NOTE]
6262
> If you are using python >= 3.13, you may encounter an issue where outlines cannot be installed due to rust compiler issues (`error: can't find Rust compiler`). You can either downgrade to python 3.12 or install the [rust compiler](https://www.rust-lang.org/tools/install) to build the wheel for outlines locally.

0 commit comments

Comments
 (0)