Skip to content

New kit import doc#711

Merged
bmicklea merged 2 commits intokitops-ml:mainfrom
bmicklea:import-doc
Jan 22, 2025
Merged

New kit import doc#711
bmicklea merged 2 commits intokitops-ml:mainfrom
bmicklea:import-doc

Conversation

@bmicklea
Copy link
Copy Markdown
Collaborator

Adds a new top-level docs page for kit import.

@bmicklea bmicklea self-assigned this Jan 22, 2025
@bmicklea
Copy link
Copy Markdown
Collaborator Author

Helps with #710, but I think we should also update the CLI docs a little.


1. **Get the HF URL**: On the Hugging Face site, copy the URL from the repository you want to create a ModelKit from (e.g., https://huggingface.co/HuggingFaceTB/SmolLM-135M-Instruct). You can also customize the name or add a tag name if desired.

1. **Kit import**: In a terminal window running Kit version 1.0.0 at least, type `kit import https://huggingface.co/HuggingFaceTB/SmolLM-135M-Instruct`. This will download and build a [Kitfile](./kitfile/kf-overview.md) based on the Hugging Face model and give you an opportunity to edit it before the ModelKit is packed.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this can be confusing, but part of the implementation was to simplify things: both

kit import https://huggingface.co/HuggingFaceTB/SmolLM-135M-Instruct

and

kit import HuggingFaceTB/SmolLM-135M-Instruct

are equivalent (i.e. you don't need the huggingface bit)

@bmicklea bmicklea merged commit 068b1ee into kitops-ml:main Jan 22, 2025
@bmicklea bmicklea deleted the import-doc branch January 22, 2025 19:32
@bmicklea
Copy link
Copy Markdown
Collaborator Author

This was related to #708

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants