Skip to content

Commit 519a35a

Browse files
authored
fix: update readme and other places with granite model and tweaks (#184)
1 parent 36eaca4 commit 519a35a

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ print(m.chat("What is the etymology of mellea?").content)
8989
9090
Then run it:
9191
> [!NOTE]
92-
> 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.
92+
> 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 4 Micro 3B model.
9393
```shell
9494
uv run --with mellea docs/examples/tutorial/example.py
9595
```
@@ -128,13 +128,13 @@ uv venv .venv && source .venv/bin/activate
128128
Use `uv pip` to install from source with the editable flag:
129129
130130
```bash
131-
uv pip install -e .[all]
131+
uv pip install -e '.[all]'
132132
```
133133
134134
If you are planning to contribute to the repo, it would be good to have all the development requirements installed:
135135
136136
```bash
137-
uv pip install .[all] --group dev --group notebook --group docs
137+
uv pip install '.[all]' --group dev --group notebook --group docs
138138
```
139139
140140
or
@@ -143,7 +143,7 @@ or
143143
uv sync --all-extras --all-groups
144144
```
145145
146-
Ensure that you install the precommit hooks:
146+
If you want to contribute, ensure that you install the precommit hooks:
147147
148148
```bash
149149
pre-commit install

docs/examples/instruct_validate_repair/101_email_comparison.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
from mellea import start_session
33
from mellea.backends.types import ModelOption
44

5-
# create a session using Granite 3.3 8B on Ollama and a simple context [see below]
5+
# create a session using Granite 4 Micro 3B on Ollama and a simple context [see below]
66
m = start_session(model_options={ModelOption.MAX_NEW_TOKENS: 200})
77

88
# Write a more formal and a more funny email

docs/examples/instruct_validate_repair/101_email_with_requirements.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
from mellea import start_session
33
from mellea.backends.types import ModelOption
44

5-
# create a session using Granite 3.3 8B on Ollama and a simple context [see below]
5+
# create a session using Granite 4 Micro 3B on Ollama and a simple context [see below]
66
m = start_session(model_options={ModelOption.MAX_NEW_TOKENS: 200})
77

88
# write an email with automatic requirement checking.

docs/examples/instruct_validate_repair/advanced_email_with_validate_function.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
from mellea.stdlib.requirement import Requirement, simple_validate
55
from mellea.stdlib.sampling import RejectionSamplingStrategy
66

7-
# create a session using Granite 3.3 8B on Ollama and a simple context [see below]
7+
# create a session using Granite 4 Micro 3B on Ollama and a simple context [see below]
88
m = start_session(model_options={ModelOption.MAX_NEW_TOKENS: 200})
99

1010
# Define a requirement which checks that the output is less than 100 words

docs/examples/tutorial/simple_email.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import mellea
22

3-
# INFO: this line will download IBM's Granite 3.3 8B model.
3+
# INFO: this line will download IBM's Granite 4 Micro 3B model.
44
m = mellea.start_session()
55

66
print("Basic email:")

docs/tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Although good generative programs can be written in any language and framework,
5050

5151
## Chapter 2: Getting Started with Generative Programming in Mellea
5252

53-
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.
53+
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 4 Micro 3B model.
5454

5555
We also recommend that you download and install [uv](https://docs.astral.sh/uv/#installation). You can run any of the examples in the tutorial with:
5656
```bash
@@ -68,7 +68,7 @@ Once you have ollama installed and running, we can get started with our first ge
6868
# file: https://github.com/generative-computing/mellea/blob/main/docs/examples/tutorial/simple_email.py#L1-L8
6969
import mellea
7070

71-
# INFO: this line will download IBM's Granite 3.3 8B model.
71+
# INFO: this line will download IBM's Granite 4 Micro 3B model.
7272
m = mellea.start_session()
7373

7474
email = m.instruct("Write an email inviting interns to an office party at 3:30pm.")

0 commit comments

Comments
 (0)