Skip to content

Commit defe6eb

Browse files
nrfultonKenOcheltree
authored andcommitted
colab links in the README.
* colab links in the README. * Fix colab links and put in updates to Notebooks --------- Co-authored-by: Kenneth Ocheltree <[email protected]>
1 parent ea7203c commit defe6eb

File tree

7 files changed

+28
-19
lines changed

7 files changed

+28
-19
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,17 @@ with structured, maintainable, robust, and efficient AI workflows.
3939

4040

4141
## Getting Started
42+
43+
You can get started with a local install, or by using Colab notebooks.
44+
45+
### Getting Started with Local Infernece
46+
4247
<img src="docs/GetStarted_py.png" style="max-width:800px">
4348

4449
Install with pip:
4550

4651
```bash
47-
uv pip install .
52+
uv pip install mellea
4853
```
4954

5055
> [!NOTE]
@@ -69,6 +74,23 @@ Then run it:
6974
uv run --with mellea docs/examples/tutorial/example.py
7075
```
7176

77+
### Get Started with Colab
78+
79+
| Notebook | Try in Colab | Goal |
80+
|----------|--------------|------|
81+
| Hello, World | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main/docs/examples/notebooks/example.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | Quick‑start demo |
82+
| Simple Email | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main/docs/examples/notebooks/simple_email.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | Using the `m.instruct` primitive |
83+
| Instruct-Validate-Repair | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main/docs/examples/notebooks/instruct_validate_repair.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | Introduces our first generative programming design pattern |
84+
| Model Options | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main/docs/examples/notsbooks/model_options_example.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | Demonstrates how to pass model options through to backends |
85+
| Sentiment Classifier | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main/docs/examples/notebooks/sentiment_classifier.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | Introduces the `@generative` decorator |
86+
| Managing Context | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main//docs/examples/notebooks/context_example.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | Shows how to construct and manage context in a `MelleaSession` |
87+
| Generative OOP | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main/docs/examples/notebooks/table_mobject.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | Demonstrates object-oriented generative programming in Mellea |
88+
| Rich Documents | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main/docs/examples/notebooks/document_mobject.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | A generative program that uses Docling to work with rich-text documents |
89+
| Composing Generative Functions | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main/docs/examples/notebooks/compositionality_with_generative_slots.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | Demonstrates contract-oriented programming in Mellea |
90+
| `m serve` | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main/docs/examples/notebooks/m_serve_example.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | Serve a generative program as an openai-compatible model endpoint |
91+
| MCP | <a href="https://colab.research.google.com/github/generative-computing/mellea/blob/main/docs/examples/notebooks/mcp_example.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/></a> | Mellea + MCP |
92+
93+
7294
### Installing from source
7395

7496
Fork and clone the repositoy:

docs/examples/notebooks/context_example.ipynb

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,6 @@
1010
"This Jupyter notebook runs on Colab and demonstrates context management."
1111
]
1212
},
13-
{
14-
"cell_type": "markdown",
15-
"metadata": {
16-
"id": "IByYhgKy9WCo",
17-
"jupyter": {
18-
"source_hidden": true
19-
}
20-
},
21-
"source": [
22-
"# Getting Started with Mellea\n",
23-
"This Jupyter notebook runs on Colab and runs the first piece of generative code."
24-
]
25-
},
2613
{
2714
"cell_type": "markdown",
2815
"metadata": {

docs/examples/notebooks/instruct_validate_repair.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
"outputs": [],
5353
"source": [
5454
"import os\n",
55-
"!git clone https://github.com/generative-computing/mellea.git --quiet --recurse-submodules\n",
55+
"!git clone https://github.com/generative-computing/mellea.git --quiet\n",
5656
"os.chdir(\"mellea\")\n",
5757
"!uv pip install . -qq"
5858
]

docs/examples/notebooks/m_serve_example.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
"outputs": [],
6363
"source": [
6464
"import os\n",
65-
"!git clone https://github.com/generative-computing/mellea.git --quiet --recurse-submodules\n",
65+
"!git clone https://github.com/generative-computing/mellea.git --quiet\n",
6666
"os.chdir(\"mellea\")\n",
6767
"!uv pip install . -qq"
6868
]

docs/examples/notebooks/mcp_example.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
},
99
"source": [
1010
"# Model Context Protocol (MCP) Server Example \n",
11-
"This Jupyter notebook runs on COlab and demonstrates a MCP server running Mellea. "
11+
"This Jupyter notebook runs on Colab and demonstrates a MCP server running Mellea. "
1212
]
1313
},
1414
{

docs/examples/notebooks/model_options_example.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
"outputs": [],
5353
"source": [
5454
"import os\n",
55-
"!git clone https://github.com/generative-computing/mellea.git --quiet --recurse-submodules\n",
55+
"!git clone https://github.com/generative-computing/mellea.git --quiet\n",
5656
"os.chdir(\"mellea\")\n",
5757
"!uv pip install . -qq"
5858
]

docs/examples/notebooks/simple_email.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
"outputs": [],
5353
"source": [
5454
"import os\n",
55-
"!git clone https://github.com/generative-computing/mellea.git --quiet --recurse-submodules\n",
55+
"!git clone https://github.com/generative-computing/mellea.git --quiet\n",
5656
"os.chdir(\"mellea\")\n",
5757
"!uv pip install . -qq"
5858
]

0 commit comments

Comments
 (0)