Merged
Conversation
Signed-off-by: kerthcet <kerthcet@gmail.com>
Signed-off-by: kerthcet <kerthcet@gmail.com>
InftyAI-Agent
added
needs-triage
Member
Author
|
/lgtm |
InftyAI-Agent
added
lgtm
There was a problem hiding this comment.
Pull request overview
Updates the project’s README for the v0.1.1 pre-release by refreshing branding and expanding user documentation around model management and CLI usage.
Changes:
- Replaces the plain title/intro with centered logo + badges and a reorganized “Features” section.
- Reworks Quick Start/Commands documentation and adds “Advanced Usage” (pattern + label filtering) and an
inspectoutput example. - Adds model storage notes, development/test instructions, and a Star History section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # Build | ||
| make build | ||
|
|
||
| # Run tests (67 unit + 22 integration) |
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="docs/images/logo.png"> | ||
| <source media="(prefers-color-scheme: light)" srcset="docs/images/logo.png"> | ||
| <img alt="PUMA Logo" src="docs/images/puma-logo-light.svg" width="240"> |
|
|
||
| ## Installation | ||
| </div> | ||
|
|
Comment on lines
+35
to
+42
| # Download a model | ||
| puma pull inftyai/tiny-random-gpt2 | ||
|
|
||
| ### 2. List Downloaded Models | ||
|
|
||
| ```bash | ||
| # List all models | ||
| puma ls | ||
| ``` | ||
|
|
||
| ### 3. Check System Information | ||
| # Inspect model details | ||
| puma inspect inftyai/tiny-random-gpt2 |
Comment on lines
+100
to
+116
| name: inftyai/tiny-random-gpt2 | ||
| kind: model | ||
| spec: | ||
| author: inftyai | ||
| task: text-generation | ||
| license: MIT | ||
| model_series: gpt2 | ||
| context_window: 2.05K | ||
| safetensors: | ||
| total: 7.00B | ||
| parameters: | ||
| f32: 7.00B | ||
| artifact: | ||
| provider: huggingface | ||
| revision: abc123de | ||
| size: 1.24 GB | ||
| cache_path: ~/.puma/cache/... |
Comment on lines
+122
to
+126
| ## Model Management | ||
|
|
||
| - **Database:** `~/.puma/models.db` (SQLite) | ||
| - **Cache:** `~/.puma/cache/` (model files) | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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?