mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-03 09:53:45 +00:00
5fe6098350
# What does this PR do? This PR improves type hint cleanup in auto-generated provider documentation by adding regex logic. **Issues Fixed:** - Type hints with missing closing brackets (e.g., `list[str` instead of `list[str]`) - Types showing as `<class 'bool'>`, `<class 'str'>` instead of `bool`, `str` - The multi-line YAML frontmatter in index documentation files wasn't ideal, so we now add the proper `|` character. **Changes:** 1. Replaced string replacement (`.replace`) with regex-based type cleaning to preserve the trailing bracket in case of `list` and `dict`. 2. Adds the `|` character for multi-line YAML descriptions. 3. I have regenerated the docs. However, let me know if that's not needed. ## Test Plan 1. Ran uv run python scripts/provider_codegen.py - successfully regenerated all docs 2. We can see that the updated docs handle correctly type hint cleanup and multi-line yaml descriptions have now the `|` character. ### Note to the reviewer(s) This is my first contribution to your lovely repo! Initially I was going thourgh docs (wanted to use `remote::gemini` as provider) and realized the issue. I've read the [CONTRIBUTING.md](https://github.com/llamastack/llama-stack/blob/main/CONTRIBUTING.md) and decided to open the PR. Let me know if there's anything I did wrong and I'll update my PR! --------- Signed-off-by: thepetk <thepetk@gmail.com> Co-authored-by: Ashwin Bharambe <ashwin.bharambe@gmail.com>
29 lines
951 B
Text
29 lines
951 B
Text
---
|
|
description: "NVIDIA's dataset I/O provider for accessing datasets from NVIDIA's data platform."
|
|
sidebar_label: Remote - Nvidia
|
|
title: remote::nvidia
|
|
---
|
|
|
|
# remote::nvidia
|
|
|
|
## Description
|
|
|
|
NVIDIA's dataset I/O provider for accessing datasets from NVIDIA's data platform.
|
|
|
|
## Configuration
|
|
|
|
| Field | Type | Required | Default | Description |
|
|
|-------|------|----------|---------|-------------|
|
|
| `api_key` | `str \| None` | No | | The NVIDIA API key. |
|
|
| `dataset_namespace` | `str \| None` | No | default | The NVIDIA dataset namespace. |
|
|
| `project_id` | `str \| None` | No | test-project | The NVIDIA project ID. |
|
|
| `datasets_url` | `str` | No | http://nemo.test | Base URL for the NeMo Dataset API |
|
|
|
|
## Sample Configuration
|
|
|
|
```yaml
|
|
api_key: ${env.NVIDIA_API_KEY:=}
|
|
dataset_namespace: ${env.NVIDIA_DATASET_NAMESPACE:=default}
|
|
project_id: ${env.NVIDIA_PROJECT_ID:=test-project}
|
|
datasets_url: ${env.NVIDIA_DATASETS_URL:=http://nemo.test}
|
|
```
|