Repository navigation
Conversation
Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com> Assisted-by: IBM Bob
github-actions
Bot
added
the
documentation
planetf1
left a comment
planetf1
left a comment
There was a problem hiding this comment.
Docs-only change; three small notes inline. CI is green at 7fbfbfd8a and example collection is unchanged (the same 15 items as main).
The README section removals match #1746. Nothing project-specific is lost: run instructions moved into each script's Usage: block, and the .py ↔ .ipynb mapping is now derivable from the two tables for all nine files.
Separately, not for this PR: README.md:278 still shows the older python <script> / uv run <script> form.
| - `instruct_validate_repair.py` ↔ `instruct_validate_repair.ipynb` | ||
| - etc. | ||
|
|
||
| ## Running the Examples |
There was a problem hiding this comment.
It may be useful for reviewers if the PR body mentioned the removed sections: "Running the Examples", "Key Concepts Covered", "Differences from Notebooks" and "Relationship to Notebooks" here, and "Benefits of Notebooks", "Corresponding Python Files" and "Tips" in notebooks/README.md. Nothing links to the removed anchors.
|
|
||
| **New to Mellea?** Start here: | ||
| 1. [tutorial/simple_email.py](tutorial/) - Your first Mellea program | ||
| 1. [tutorial/simple_email.py](tutorial/simple_email.py) - Your first Mellea program |
There was a problem hiding this comment.
Same fix needed one more time, though this line is pre-existing: 245 still has [tutorial/sentiment_classifier.py](tutorial/), so it points at the directory rather than the script.
|
|
||
| Prerequisites: | ||
| ollama serve | ||
| ollama pull granite4.2:3b |
There was a problem hiding this comment.
The comment at line 14 still reads # INFO: this line will download IBM's Granite 4 Micro 3B model., which now contradicts this line — the default is granite4.2:3b. Worth deleting or updating while you're in here.
Remove stale Granite 4 Micro download comment from simple_email.py and point the sentiment_classifier.py link at the script. Assisted-by: IBM Bob Signed-off-by: Rafael Vasquez <rafvasq21@gmail.com>
Pull Request
Issue
Towards #1746
Description
Standardizes
tutorial/,notebooks/, the rootdocs/examples/README.md, and the root example scripts.Docstrings
Prerequisites:(where they're required) andUsage:blocks.READMEs
tutorial/andnotebooks/: the file lists are now## Examplestables using the original descriptions, with a "See Also" section linking the two directories and the first tutorial.tutorial/README.md: "Running the Examples", "Key Concepts Covered", "Differences from Notebooks", "Relationship to Notebooks".notebooks/README.md: "Benefits of Notebooks", "Corresponding Python Files", "Tips".Usage:block. The.py↔.ipynbmapping can be read from the two## Examplestables.Other fixes
README.md:sampling/andprimitives/entries.tutorial/simple_email.pylink, which was pointing at the directory.tutorial/table_mobject.py: added the missinguv pip install pandasprerequisite.tutorial/document_mobject.py: removed an unusedIBM_GRANITE_4_HYBRID_MICROimport.Testing
Attribution
Adding a new component, requirement, sampling strategy, or tool?
If your PR adds or modifies one of the types below, check the matching box. A checklist of type-specific review items will be posted as a comment.
NOTE: Please ensure you have an issue that has been acknowledged by a core contributor and routed you to open a pull request against this repository. Otherwise, please open an issue before continuing with this pull request.