-
Notifications
You must be signed in to change notification settings - Fork 148
feat: Add NVIDIA NIM and MLX model provider documentation #393
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
feat: Add NVIDIA NIM and MLX model provider documentation #393
Conversation
|
|
||
| ```bash | ||
| # Create virtual environment with Python 3.13 | ||
| uv venv --python 3.13 && source .venv/bin/activate |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't use uv on the other providers - I don't mind doing so, but let's put pip first for consistency and then mention uv.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Uv is preferred in strands-mlx, directing pip for consistency makes sense but that will require change README of strands-mlx so i'd rather not change readme for only docs repository.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so i'd rather not change readme for only docs repository.
My concern is the reverse problem - this is the only page that only uses uv where elsewhere we guide the user on using pip directly. So now a single page is introducing a new tool that isn't mentioned elsewhere. Given that these docs are focused on strands customers, I think the docs being consistent here makes more sense.
directing pip for consistency makes sense but that will require change README of strands-mlx
I expect and encourage readmes to differ from what's put on the doc pages here - this is meant to be a quick overview of a given package if you're trying to get started
| pip install strands-mlx strands-agents-tools | ||
| ``` | ||
|
|
||
| ## Quick Start |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thoughts about relabeling this to ## Usage to match the other providers?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Strands-MLX repository have more documentation down below, trying to match with other providers does not makes sense to me. :/
| agent("What is 29 * 42?") | ||
| ``` | ||
|
|
||
| ### Vision Models |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An intro text blurb might be useful in these two sections. E.g. "MLX also supports vision models which can understand/parse images, videos, and audio"
Should this agent also have a read_file so that it can grab the given files?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need for external tools to get the file contents.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm confused in this example then - when I run this:
agent("Describe: <image>photo.jpg</image>")where is the photo coming from?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's the path of file in xml tags
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See this CI run for example; https://github.com/cagataycali/strands-mlx/actions/runs/19022576846/job/54320258769#step:13:1
| ### Using Environment Variables (Recommended) | ||
|
|
||
| ```bash | ||
| # Set your API key as an environment variable |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider elevating this text to be a paragraph instead of in the code sample
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
?
Removed link to Strands Agents SDK from NVIDIA NIM documentation.
Added a note to set the API key as an environment variable.
|
Closing due missing contributing guide |
Summary
Adds comprehensive documentation for two new community model providers:
NVIDIA NIM
MLX (Apple Silicon)
Changes
/docs/community/model-providers/nvidia-nim.md/docs/community/model-providers/mlx.mdmkdocs.ymlto include new provider pagesTesting