leftmove / leftmove/cria

Inherited documentation/code from Ollama

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue
Dominant language
Python
Stars
119
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Cria has many features inherited from ollama.

ai = cria.Cria()

prompt = "Return a JSON array of car brands."
response = ai.chat(prompt=prompt, stream=False, format="json")

Features like the above, where passing in format="json" ensures JSON output, are available from ollama, but not documented for Cria. Documentation can be found on ollama, but it would be useful to have that documentation natively.

This issue is meant for beginners, and if you are interested in either porting some more esoteric features from ollama over to Cria, or simply writing some documentation, you can help with this issue.

Important: If you want to work on this issue, please @ me and I will assign you. Once assigned, I can give you some more context depending on what you want to help with, and fill you in on some of Cria's more confusing source code.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Ollama Python documentation linked in the issue and the cria.Cria and ai.chat entry points shown in its example. Identify inherited features that Cria supports but does not document, then add native Cria documentation covering the selected feature or features and confirm the examples match the available API.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.