|
| 1 | +# NVIDIA NIM Provider Preset Implementation Plan |
| 2 | + |
| 3 | +> **For Claude:** REQUIRED SUB-SKILL: Use superpowers:executing-plans to implement this plan task-by-task. |
| 4 | +
|
| 5 | +**Goal:** Add an out-of-the-box NVIDIA NIM provider preset (OpenAI-compatible) and document how to use it. |
| 6 | + |
| 7 | +**Architecture:** Treat NVIDIA NIM as `openai_compatible` (Chat Completions). Add a `providers.nvidia` preset in the default `~/.rexos/config.toml` generation, plus docs examples and env var setup. |
| 8 | + |
| 9 | +**Tech Stack:** Rust (Cargo workspace), `reqwest` (OpenAI-compatible client), MkDocs Material + `mkdocs-static-i18n` docs site. |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +### Task 1: Add a failing test for the NVIDIA preset |
| 14 | + |
| 15 | +**Files:** |
| 16 | +- Modify: `meos/crates/rexos-kernel/src/config.rs` |
| 17 | +- Test: `meos/crates/rexos-kernel/src/config.rs` |
| 18 | + |
| 19 | +**Step 1: Write the failing test** |
| 20 | + |
| 21 | +Add one assertion to `default_config_serializes()`: |
| 22 | + |
| 23 | +```rust |
| 24 | +assert!(toml_str.contains("[providers.nvidia]")); |
| 25 | +``` |
| 26 | + |
| 27 | +**Step 2: Run test to verify it fails** |
| 28 | + |
| 29 | +Run: |
| 30 | + |
| 31 | +```bash |
| 32 | +cargo test -p rexos-kernel default_config_serializes |
| 33 | +``` |
| 34 | + |
| 35 | +Expected: FAIL because the default config doesn’t include `providers.nvidia` yet. |
| 36 | + |
| 37 | +--- |
| 38 | + |
| 39 | +### Task 2: Add a failing preset sanity test (base URL) |
| 40 | + |
| 41 | +**Files:** |
| 42 | +- Modify: `meos/crates/rexos-kernel/src/config.rs` |
| 43 | +- Test: `meos/crates/rexos-kernel/src/config.rs` |
| 44 | + |
| 45 | +**Step 1: Write the failing test** |
| 46 | + |
| 47 | +Add: |
| 48 | + |
| 49 | +```rust |
| 50 | +#[test] |
| 51 | +fn nvidia_preset_uses_nim_base_url() { |
| 52 | + let cfg = RexosConfig::default(); |
| 53 | + let nvidia = cfg.providers.get("nvidia").unwrap(); |
| 54 | + assert_eq!(nvidia.base_url, "https://integrate.api.nvidia.com/v1"); |
| 55 | +} |
| 56 | +``` |
| 57 | + |
| 58 | +**Step 2: Run test to verify it fails** |
| 59 | + |
| 60 | +Run: |
| 61 | + |
| 62 | +```bash |
| 63 | +cargo test -p rexos-kernel nvidia_preset_uses_nim_base_url |
| 64 | +``` |
| 65 | + |
| 66 | +Expected: FAIL until the `nvidia` preset exists. |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +### Task 3: Implement the NVIDIA preset in default config |
| 71 | + |
| 72 | +**Files:** |
| 73 | +- Modify: `meos/crates/rexos-kernel/src/config.rs` |
| 74 | +- Test: `meos/crates/rexos-kernel/src/config.rs` |
| 75 | + |
| 76 | +**Step 1: Write minimal implementation** |
| 77 | + |
| 78 | +In `RexosConfig::default()`, insert: |
| 79 | + |
| 80 | +```rust |
| 81 | +providers.insert( |
| 82 | + "nvidia".to_string(), |
| 83 | + ProviderConfig { |
| 84 | + kind: ProviderKind::OpenAiCompatible, |
| 85 | + base_url: "https://integrate.api.nvidia.com/v1".to_string(), |
| 86 | + api_key_env: "NVIDIA_API_KEY".to_string(), |
| 87 | + default_model: "meta/llama-3.2-3b-instruct".to_string(), |
| 88 | + }, |
| 89 | +); |
| 90 | +``` |
| 91 | + |
| 92 | +**Step 2: Run tests to verify they pass** |
| 93 | + |
| 94 | +Run: |
| 95 | + |
| 96 | +```bash |
| 97 | +cargo test -p rexos-kernel default_config_serializes |
| 98 | +cargo test -p rexos-kernel nvidia_preset_uses_nim_base_url |
| 99 | +``` |
| 100 | + |
| 101 | +Expected: PASS. |
| 102 | + |
| 103 | +--- |
| 104 | + |
| 105 | +### Task 4: Update docs (English + Chinese) |
| 106 | + |
| 107 | +**Files:** |
| 108 | +- Modify: `meos/docs-site/how-to/providers.md` |
| 109 | +- Modify: `meos/docs-site/zh/how-to/providers.md` |
| 110 | +- Modify: `meos/docs-site/index.md` |
| 111 | +- Modify: `meos/docs-site/zh/index.md` |
| 112 | +- Modify: `meos/README.md` |
| 113 | +- Modify: `meos/README.zh-CN.md` |
| 114 | + |
| 115 | +**Step 1: Add preset mention** |
| 116 | + |
| 117 | +Add `nvidia` to the built-in presets list. |
| 118 | + |
| 119 | +**Step 2: Add a provider example** |
| 120 | + |
| 121 | +Add a new section “Example: NVIDIA NIM” with: |
| 122 | +- `base_url = "https://integrate.api.nvidia.com/v1"` |
| 123 | +- `api_key_env = "NVIDIA_API_KEY"` |
| 124 | +- `default_model = "meta/llama-3.2-3b-instruct"` |
| 125 | + |
| 126 | +**Step 3: Add env var instructions** |
| 127 | + |
| 128 | +Add `NVIDIA_API_KEY` to the API key lists (Bash + PowerShell). |
| 129 | + |
| 130 | +**Step 4: Validate docs build** |
| 131 | + |
| 132 | +Run: |
| 133 | + |
| 134 | +```bash |
| 135 | +python3 -m mkdocs build --strict |
| 136 | +``` |
| 137 | + |
| 138 | +Expected: success. |
0 commit comments