Conversation
Signed-off-by: kerthcet <kerthcet@gmail.com>
|
/kind documentation |
InftyAI-Agent
added
needs-triage
There was a problem hiding this comment.
Pull request overview
Updates the project README to better document PUMA’s capabilities and provide a more complete onboarding experience for building and using the CLI.
Changes:
- Expands the README with installation instructions, a Quick Start flow, and example output.
- Reworks the commands section into a richer table (status + examples) and adds configuration/provider notes.
- Adds a project structure overview plus license/contributing sections.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # From Hugging Face (default) | ||
| puma pull InftyAI/tiny-random-gpt2 | ||
| ``` | ||
|
|
There was a problem hiding this comment.
The Installation section says the binary will be available as ./puma, but the Quick Start examples invoke puma ... (which assumes it’s on PATH). Update the examples to use ./puma or add an explicit step to install/add the binary to PATH before using puma without a relative path.
| | `ls` | ✅ | List local models | `puma ls` | | ||
| | `ps` | 🚧 | List running models | `puma ps` | | ||
| | `run` | 🚧 | Create and run a model | `puma run InftyAI/tiny-random-gpt2` | | ||
| | `stop` | 🚧 | Stop a running model | `puma stop <model-id>` | |
There was a problem hiding this comment.
The README shows puma run InftyAI/tiny-random-gpt2, but the current CLI defines run as a subcommand with no arguments. This example will fail with an “unexpected argument” error unless the CLI is updated to accept a model argument (or the README example is changed).
| | `stop` | 🚧 | Stop a running model | `puma stop <model-id>` | | |
| | `stop` | 🚧 | Stop a running model | `TBD` | |
| | `ls` | ✅ | List local models | `puma ls` | | ||
| | `ps` | 🚧 | List running models | `puma ps` | | ||
| | `run` | 🚧 | Create and run a model | `puma run InftyAI/tiny-random-gpt2` | | ||
| | `stop` | 🚧 | Stop a running model | `puma stop <model-id>` | |
There was a problem hiding this comment.
The README shows puma stop <model-id>, but the current CLI defines stop as a subcommand with no arguments. Either update the README example to match the current interface or update the CLI to accept a model/service identifier.
| | `stop` | 🚧 | Stop a running model | `puma stop <model-id>` | | |
| | `stop` | 🚧 | Stop a running model | `puma stop` | |
| | `stop` | 🚧 | Stop a running model | `puma stop <model-id>` | | ||
| | `rm` | ✅ | Remove a model | `puma rm InftyAI/tiny-random-gpt2` | | ||
| | `info` | ✅ | Display system-wide information | `puma info` | | ||
| | `inspect` | 🚧 | Return detailed information about a model or service | `puma inspect InftyAI/tiny-random-gpt2` | |
There was a problem hiding this comment.
The README shows puma inspect InftyAI/tiny-random-gpt2, but the current CLI defines inspect as a subcommand with no arguments. This example will fail unless inspect is implemented to accept a target argument, or the README is adjusted.
| | `inspect` | 🚧 | Return detailed information about a model or service | `puma inspect InftyAI/tiny-random-gpt2` | | |
| | `inspect` | 🚧 | Return detailed inspection information | `puma inspect` | |
|
|
||
| ## Supported Providers | ||
|
|
||
| - **Hugging Face** - Full support with custom cache directories |
There was a problem hiding this comment.
The Features list mentions “ModelScope coming soon”, but the “Supported Providers” section only lists Hugging Face. Consider adding a ModelScope “coming soon” entry (or removing the mention) so the README is internally consistent.
| - **Hugging Face** - Full support with custom cache directories | |
| - **Hugging Face** - Full support with custom cache directories | |
| - **ModelScope** - Coming soon |
| # PUMA | ||
|
|
||
| **PUMA** aims to be a lightweight, high-performance inference engine for local AI. *Play for fun.* | ||
| A lightweight, high-performance inference engine for local AI. *Play for fun.* |
There was a problem hiding this comment.
The PR description still contains the template placeholder Fixes # with no issue number/link filled in. Either link the actual issue (e.g., Fixes #123) or remove the placeholder so the PR metadata is accurate.
* Support HF downloading models (#16) * Add HF downloader support Signed-off-by: kerthcet <kerthcet@gmail.com> * add bars Signed-off-by: kerthcet <kerthcet@gmail.com> * fix color Signed-off-by: kerthcet <kerthcet@gmail.com> * fix color Signed-off-by: kerthcet <kerthcet@gmail.com> * add download successfully message Signed-off-by: kerthcet <kerthcet@gmail.com> * change the color Signed-off-by: kerthcet <kerthcet@gmail.com> * change the rending shape Signed-off-by: kerthcet <kerthcet@gmail.com> --------- Signed-off-by: kerthcet <kerthcet@gmail.com> * Support `puma rm <model>` (#17) * support new cache structure Signed-off-by: kerthcet <kerthcet@gmail.com> * support puma rm Signed-off-by: kerthcet <kerthcet@gmail.com> * use readable format Signed-off-by: kerthcet <kerthcet@gmail.com> * remove requests.rs Signed-off-by: kerthcet <kerthcet@gmail.com> * fix lint Signed-off-by: kerthcet <kerthcet@gmail.com> --------- Signed-off-by: kerthcet <kerthcet@gmail.com> * support puma info (#18) Signed-off-by: kerthcet <kerthcet@gmail.com> * Reuse the model cache to avoid duplicate download (#19) * polish the format of the ls command Signed-off-by: kerthcet <kerthcet@gmail.com> * Have a progress manager Signed-off-by: kerthcet <kerthcet@gmail.com> * Reuse caches Signed-off-by: kerthcet <kerthcet@gmail.com> * rename util to utils Signed-off-by: kerthcet <kerthcet@gmail.com> * polish the layout of the download progress Signed-off-by: kerthcet <kerthcet@gmail.com> * revert change Signed-off-by: kerthcet <kerthcet@gmail.com> * add make format Signed-off-by: kerthcet <kerthcet@gmail.com> --------- Signed-off-by: kerthcet <kerthcet@gmail.com> * remove available mem (#22) Signed-off-by: kerthcet <kerthcet@gmail.com> * add speed at the end (#23) * add speed at the end Signed-off-by: kerthcet <kerthcet@gmail.com> * fix lint Signed-off-by: kerthcet <kerthcet@gmail.com> --------- Signed-off-by: kerthcet <kerthcet@gmail.com> * fix: do no register model once cached (#26) Signed-off-by: kerthcet <kerthcet@gmail.com> * Support GPU detect (#27) * support GPU detect Signed-off-by: kerthcet <kerthcet@gmail.com> * fix lint Signed-off-by: kerthcet <kerthcet@gmail.com> --------- Signed-off-by: kerthcet <kerthcet@gmail.com> * update readme.md (#28) Signed-off-by: kerthcet <kerthcet@gmail.com> * Support inspect command (#29) * add support for inspect Signed-off-by: kerthcet <kerthcet@gmail.com> * add support for inspect Signed-off-by: kerthcet <kerthcet@gmail.com> * add pull progress bar Signed-off-by: kerthcet <kerthcet@gmail.com> * polish the download progress Signed-off-by: kerthcet <kerthcet@gmail.com> * reorganize the structure Signed-off-by: kerthcet <kerthcet@gmail.com> * optimize the structure Signed-off-by: kerthcet <kerthcet@gmail.com> * fix test Signed-off-by: kerthcet <kerthcet@gmail.com> * fix lint Signed-off-by: kerthcet <kerthcet@gmail.com> --------- Signed-off-by: kerthcet <kerthcet@gmail.com> * add metadata Signed-off-by: kerthcet <kerthcet@gmail.com> --------- Signed-off-by: kerthcet <kerthcet@gmail.com>
What this PR does / why we need it
Which issue(s) this PR fixes
Fixes #
Special notes for your reviewer
Does this PR introduce a user-facing change?