Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add support for model providers with usage examples #2866

Merged
merged 8 commits into from
Nov 14, 2024

Conversation

Haleshot
Copy link
Contributor

📝 Summary

Update the chat.md file to include examples for GROQ and Cerebras model providers (while also linking the LiteLLM page to showcase various other model providers).
Address comment - #2773 (comment)

🔍 Description of Changes

  • Added examples for GROQ and Cerebras model providers.
  • Included a note about the availability of free API keys for GROQ and Cerebras.
  • Provided guidance on finding the correct endpoint URLs for model providers (refer to docs; usually found in the curl commands).

📋 Checklist

  • I have read the contributor guidelines.
  • For large changes, or changes that affect the public API: this change was discussed or approved through an issue, on Discord, or the community discussions (Please provide a link if applicable).
  • I have added tests for the changes made.
  • I have run the code and verified that it works as expected.

📜 Reviewers

@akshayka OR @mscolnick

Copy link

vercel bot commented Nov 14, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
marimo-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 14, 2024 7:22pm
marimo-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 14, 2024 7:22pm

@@ -37,6 +37,88 @@ AI models from popular providers or custom functions.

## Basic Usage

## Supported Model Providers
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can this go at the bottom?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can this go at the bottom?

Sure, will reposition this.

::::

```{note}
We have added examples for GROQ and Cerebras. These providers offer free API keys and are great for trying out Llama models (from Meta). Cerebras, as of today, offers the fastest inferencing of the Llama3.1 70B model and GROQ is also competitive in this space.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can drop Cerebras, as of today,...competitive in this space.

chatbot
```

We recommend using free providers like [GROQ](https://groq.com/) and [Cerebras](https://cerebras.ai/), as you can sign up on their platforms and integrate with various AI integrations in marimo easily. For more information, refer to the [AI completion documentation in marimo](https://docs.marimo.io/guides/editor_features/ai_completion.html#ai-completion).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could be /guides/editor_features/ai_completion#ai-completion

chatbot
```

We recommend using free providers like [GROQ](https://groq.com/) and [Cerebras](https://cerebras.ai/), as you can sign up on their platforms and integrate with various AI integrations in marimo easily. For more information, refer to the [AI completion documentation in marimo](https://docs.marimo.io/guides/editor_features/ai_completion.html#ai-completion).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think you pretty much mention this in the note above. i would either consolidate or remove this one


If you want more examples for model providers and their endpoints listed, please submit a [feature request](https://github.com/marimo-team/marimo/issues/new?template=documentation.yaml).

### Example Usage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think we can delete these, we already have the same example above

Copy link
Contributor Author

@Haleshot Haleshot Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah alright; my reasoning was, the first link above (is for a feature request) to include model providers which can't be run through overriding the base_url -> not openAI compatible; the hyperlink below is for a doc change (.doc.yaml) if people want more model providers to be listed in this chat.md doc webpage (for reference). Can remove it to not be seen as repetitive from the outside (though the hyperlinks are different).

```

:::
::::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add an entry for xai? then we can close out that ticket #2773

model="grok-beta",
base_url="https://api.x.ai/v1",

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the info, will do it now. (Didn't do it earlier as I could not test it - don't have an API key as such) and wanted to be sure before having that as a category.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i pulled this from their docs, i think its ok to not test and assume their docs are accurate in that case

Copy link
Contributor

@mscolnick mscolnick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks great, thank you!

Copy link

🚀 Development release published. You may be able to view the changes at https://marimo.app?v=0.9.19-dev7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants