mellea 0.0.1__tar.gz

mellea-0.0.1/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

mellea-0.0.1/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.1
+Name: mellea
+Version: 0.0.1
+Summary: mellea is a library for writing generative programs
+Author-Email: Nathan Fulton <nathan@ibm.com>, Hendrik Strobelt <hendrik.strobelt@ibm.com>, Avinash Balakrishnan <avinash.bala@us.ibm.com>, Elron Bandel <elron.bandel@ibm.com>, Masataro Asai <masataro.asai@ibm.com>, Supriya Lall <supriya.lall@partner.ibm.com>, Xiaojie Guo <xiaojie.guo@ibm.com>, Jake LoRocco <jake.lorocco@ibm.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Requires-Dist: pydantic
+Requires-Dist: outlines<1.0.0
+Requires-Dist: openai
+Requires-Dist: jinja2
+Requires-Dist: transformers
+Requires-Dist: torchvision
+Requires-Dist: accelerate>=0.26.0
+Requires-Dist: json5
+Requires-Dist: docling==2.28.1
+Requires-Dist: ollama>=0.5.1
+Requires-Dist: alora==0.2.0
+Requires-Dist: ansicolors
+Requires-Dist: datasets
+Requires-Dist: ibm-watsonx-ai
+Requires-Dist: requests>=2.32.3
+Requires-Dist: uvicorn
+Requires-Dist: fastapi
+Requires-Dist: types-requests
+Requires-Dist: types-tqdm
+Requires-Dist: typer
+Requires-Dist: click<8.2.0
+Requires-Dist: mistletoe>=1.4.0
+Requires-Dist: trl==0.19.0
+Requires-Dist: peft
+Requires-Dist: torch
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: mypy-extensions; extra == "dev"
+Requires-Dist: tomli; extra == "dev"
+Requires-Dist: codespell; extra == "dev"
+Provides-Extra: sphinx
+Requires-Dist: sphinx_rtd_theme; extra == "sphinx"
+Requires-Dist: sphinx-autodoc-typehints; extra == "sphinx"
+Requires-Dist: sphinx_mdinclude; extra == "sphinx"
+Description-Content-Type: text/markdown
+
+<img src="docs/mellea_draft_logo_300.png" height=100>
+
+# Mellea
+
+Mellea is a library for writing generative programs.
+Generative programming replaces flaky agents and brittle prompts
+with structured, maintainable, robust, and efficient AI workflows.
+
+
+[//]: # ([![arXiv]&#40;https://img.shields.io/badge/arXiv-2408.09869-b31b1b.svg&#41;]&#40;https://arxiv.org/abs/2408.09869&#41;)
+[![Docs](https://img.shields.io/badge/docs-live-brightgreen)](https://docs.mellea.ai/)
+[![PyPI version](https://img.shields.io/pypi/v/mellea)](https://pypi.org/project/mellea/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mellea)](https://pypi.org/project/mellea/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+![GitHub License](https://img.shields.io/github/license/generative-computing/mellea)
+
+
+## Features
+
+ * A standard library of opinionated prompting patterns.
+ * Sampling strategies for inference-time scaling.
+ * Clean integration between verifiers and samplers.
+    - Batteries-included library of verifiers.
+    - Support for efficient checking of specialized requirements using
+      activated LoRAs.
+    - Train your own verifiers on proprietary classifier data.
+ * Compatible with many inference services and model families. Control cost
+   and quality by easily lifting and shifting workloads between:
+        - inference providers
+        - model families
+        - model sizes
+ * Easily integrate the power of LLMs into legacy code-bases (mify).
+ * Sketch applications by writing specifications and letting `mellea` fill in
+   the details (generative slots).
+ * Get started by decomposing your large unwieldy prompts into structured and maintainable mellea problems.
+
+
+
+## Getting Started
+
+You can get started with a local install, or by using Colab notebooks.
+
+### Getting Started with Local Infernece
+
+<img src="docs/GetStarted_py.png" style="max-width:800px">
+
+Install with pip:
+
+```bash
+uv pip install mellea
+```
+
+> [!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 .`. To run the examples, you will need to use `python <filename>` inside the conda environment instead of `uv run --with mellea <filename>`.
+
+> [!NOTE]
+> 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.
+
+For running a simple LLM request locally (using Ollama with Granite model), this is the starting code:
+```python
+# file: https://github.com/generative-computing/mellea/blob/main/docs/examples/tutorial/example.py
+import mellea
+
+m = mellea.start_session()
+print(m.chat("What is the etymology of mellea?").content)
+```
+
+
+Then run it:
+> 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.
+```shell
+uv run --with mellea docs/examples/tutorial/example.py
+```
+
+### Get Started with Colab
+
+| Notebook | Try in Colab | Goal |
+|----------|--------------|------|
+| 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 |
+| 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 |
+| 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 |
+| 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 |
+| 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 |
+| 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` |
+| 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 |
+| 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 |
+| 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 |
+| `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 |
+| 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 |
+
+
+### Installing from source
+
+Fork and clone the repositoy:
+
+```bash
+git clone ssh://git@github.com/<my-username>/mellea.git && cd mellea/
+```
+
+Setup a virtual environment:
+
+```bash
+uv venv .venv && source .venv/bin/activate
+```
+
+Use `uv pip` to install from source with the editable flag:
+
+```bash
+uv pip install -e .
+```
+
+Ensure that you install the precommit hooks:
+
+```bash
+pre-commit install
+```
+
+## Getting started with validation
+
+Mellea supports validation of generation results through a **instruct-validate-repair** pattern.
+Below, the request for *"Write an email.."* is constrained by the requirements of *"be formal"* and *"Use 'Dear interns' as greeting."*.
+Using a simple rejection sampling strategy, the request is sent up to three (loop_budget) times to the model and
+the output is checked against the constraints using (in this case) LLM-as-a-judge.
+
+
+```python
+# file: https://github.com/generative-computing/mellea/blob/main/docs/examples/instruct_validate_repair/101_email_with_validate.py
+from mellea import MelleaSession
+from mellea.backends.types import ModelOption
+from mellea.backends.ollama import OllamaModelBackend
+from mellea.backends import model_ids
+from mellea.stdlib.sampling import RejectionSamplingStrategy
+
+# create a session with Mistral running on Ollama
+m = MelleaSession(
+    backend=OllamaModelBackend(
+        model_id=model_ids.MISTRALAI_MISTRAL_0_3_7B,
+        model_options={ModelOption.MAX_NEW_TOKENS: 300},
+    )
+)
+
+# run an instruction with requirements
+email_v1 = m.instruct(
+    "Write an email to invite all interns to the office party.",
+    requirements=["be formal", "Use 'Dear interns' as greeting."],
+    strategy=RejectionSamplingStrategy(loop_budget=3),
+)
+
+# print result
+print(f"***** email ****\n{str(email_v1)}\n*******")
+```
+
+
+## Getting Started with Generative Slots
+
+Generative slots allow you to define functions without implementing them.
+The `@generative` decorator marks a function as one that should be interpreted by querying an LLM.
+The example below demonstrates how an LLM's sentiment classification
+capability can be wrapped up as a function using Mellea's generative slots and
+a local LLM.
+
+
+```python
+# file: https://github.com/generative-computing/mellea/blob/main/docs/examples/tutorial/sentiment_classifier.py#L1-L13
+from typing import Literal
+from mellea import generative, start_session
+
+
+@generative
+def classify_sentiment(text: str) -> Literal["positive", "negative"]:
+  """Classify the sentiment of the input text as 'positive' or 'negative'."""
+
+
+if __name__ == "__main__":
+  m = start_session()
+  sentiment = classify_sentiment(m, text="I love this!")
+  print("Output sentiment is:", sentiment)
+```
+
+
+
+## Tutorial
+
+See the [tutorial](docs/tutorial.md)
+
+## Contributing
+
+Please refer to the [Contributor Guide](docs/tutorial.md#appendix-contributing-to-mellea) for detailed instructions on how to contribute.
+
+### IBM ❤️ Open Source AI
+
+Mellea has been started by IBM Research in Cambridge, MA.
+
+
+

mellea-0.0.1/README.md

@@ -0,0 +1,197 @@
+<img src="docs/mellea_draft_logo_300.png" height=100>
+
+# Mellea
+
+Mellea is a library for writing generative programs.
+Generative programming replaces flaky agents and brittle prompts
+with structured, maintainable, robust, and efficient AI workflows.
+
+
+[//]: # ([![arXiv]&#40;https://img.shields.io/badge/arXiv-2408.09869-b31b1b.svg&#41;]&#40;https://arxiv.org/abs/2408.09869&#41;)
+[![Docs](https://img.shields.io/badge/docs-live-brightgreen)](https://docs.mellea.ai/)
+[![PyPI version](https://img.shields.io/pypi/v/mellea)](https://pypi.org/project/mellea/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mellea)](https://pypi.org/project/mellea/)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+![GitHub License](https://img.shields.io/github/license/generative-computing/mellea)
+
+
+## Features
+
+ * A standard library of opinionated prompting patterns.
+ * Sampling strategies for inference-time scaling.
+ * Clean integration between verifiers and samplers.
+    - Batteries-included library of verifiers.
+    - Support for efficient checking of specialized requirements using
+      activated LoRAs.
+    - Train your own verifiers on proprietary classifier data.
+ * Compatible with many inference services and model families. Control cost
+   and quality by easily lifting and shifting workloads between:
+        - inference providers
+        - model families
+        - model sizes
+ * Easily integrate the power of LLMs into legacy code-bases (mify).
+ * Sketch applications by writing specifications and letting `mellea` fill in
+   the details (generative slots).
+ * Get started by decomposing your large unwieldy prompts into structured and maintainable mellea problems.
+
+
+
+## Getting Started
+
+You can get started with a local install, or by using Colab notebooks.
+
+### Getting Started with Local Infernece
+
+<img src="docs/GetStarted_py.png" style="max-width:800px">
+
+Install with pip:
+
+```bash
+uv pip install mellea
+```
+
+> [!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 .`. To run the examples, you will need to use `python <filename>` inside the conda environment instead of `uv run --with mellea <filename>`.
+
+> [!NOTE]
+> 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.
+
+For running a simple LLM request locally (using Ollama with Granite model), this is the starting code:
+```python
+# file: https://github.com/generative-computing/mellea/blob/main/docs/examples/tutorial/example.py
+import mellea
+
+m = mellea.start_session()
+print(m.chat("What is the etymology of mellea?").content)
+```
+
+
+Then run it:
+> 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.
+```shell
+uv run --with mellea docs/examples/tutorial/example.py
+```
+
+### Get Started with Colab
+
+| Notebook | Try in Colab | Goal |
+|----------|--------------|------|
+| 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 |
+| 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 |
+| 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 |
+| 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 |
+| 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 |
+| 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` |
+| 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 |
+| 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 |
+| 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 |
+| `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 |
+| 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 |
+
+
+### Installing from source
+
+Fork and clone the repositoy:
+
+```bash
+git clone ssh://git@github.com/<my-username>/mellea.git && cd mellea/
+```
+
+Setup a virtual environment:
+
+```bash
+uv venv .venv && source .venv/bin/activate
+```
+
+Use `uv pip` to install from source with the editable flag:
+
+```bash
+uv pip install -e .
+```
+
+Ensure that you install the precommit hooks:
+
+```bash
+pre-commit install
+```
+
+## Getting started with validation
+
+Mellea supports validation of generation results through a **instruct-validate-repair** pattern.
+Below, the request for *"Write an email.."* is constrained by the requirements of *"be formal"* and *"Use 'Dear interns' as greeting."*.
+Using a simple rejection sampling strategy, the request is sent up to three (loop_budget) times to the model and
+the output is checked against the constraints using (in this case) LLM-as-a-judge.
+
+
+```python
+# file: https://github.com/generative-computing/mellea/blob/main/docs/examples/instruct_validate_repair/101_email_with_validate.py
+from mellea import MelleaSession
+from mellea.backends.types import ModelOption
+from mellea.backends.ollama import OllamaModelBackend
+from mellea.backends import model_ids
+from mellea.stdlib.sampling import RejectionSamplingStrategy
+
+# create a session with Mistral running on Ollama
+m = MelleaSession(
+    backend=OllamaModelBackend(
+        model_id=model_ids.MISTRALAI_MISTRAL_0_3_7B,
+        model_options={ModelOption.MAX_NEW_TOKENS: 300},
+    )
+)
+
+# run an instruction with requirements
+email_v1 = m.instruct(
+    "Write an email to invite all interns to the office party.",
+    requirements=["be formal", "Use 'Dear interns' as greeting."],
+    strategy=RejectionSamplingStrategy(loop_budget=3),
+)
+
+# print result
+print(f"***** email ****\n{str(email_v1)}\n*******")
+```
+
+
+## Getting Started with Generative Slots
+
+Generative slots allow you to define functions without implementing them.
+The `@generative` decorator marks a function as one that should be interpreted by querying an LLM.
+The example below demonstrates how an LLM's sentiment classification
+capability can be wrapped up as a function using Mellea's generative slots and
+a local LLM.
+
+
+```python
+# file: https://github.com/generative-computing/mellea/blob/main/docs/examples/tutorial/sentiment_classifier.py#L1-L13
+from typing import Literal
+from mellea import generative, start_session
+
+
+@generative
+def classify_sentiment(text: str) -> Literal["positive", "negative"]:
+  """Classify the sentiment of the input text as 'positive' or 'negative'."""
+
+
+if __name__ == "__main__":
+  m = start_session()
+  sentiment = classify_sentiment(m, text="I love this!")
+  print("Output sentiment is:", sentiment)
+```
+
+
+
+## Tutorial
+
+See the [tutorial](docs/tutorial.md)
+
+## Contributing
+
+Please refer to the [Contributor Guide](docs/tutorial.md#appendix-contributing-to-mellea) for detailed instructions on how to contribute.
+
+### IBM ❤️ Open Source AI
+
+Mellea has been started by IBM Research in Cambridge, MA.
+
+
+

mellea-0.0.1/cli/__init__.py

@@ -0,0 +1 @@
+"""cli for the M library."""

mellea-0.0.1/cli/alora/__init__.py

@@ -0,0 +1,2 @@
+# cli/alora/__init__.py
+"""alora command group package for training and uploading adapters."""