Skip to content

Update documentation for Kit import #712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amisevsk merged 1 commit into from
Jan 22, 2025
Merged

Update documentation for Kit import #712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions docs/src/docs/cli/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@ Start development server (experimental) from a modelkit
Start a development server for an unpacked modelkit, using a context directory
that includes the model and a kitfile.


```
kit dev start <directory> [flags]
```
Expand Down Expand Up @@ -147,9 +146,15 @@ Import a model from HuggingFace
### Synopsis

Download a repository from HuggingFace and package it as a ModelKit.

The repository will be downloaded to a temporary directory and be packaged using a
generated Kitfile.

The repository can be specified either via a repository (e.g. myorg/myrepo) or
with a full URL (https://huggingface.co/myorg/myrepo). The repository will be
downloaded to a temporary directory and be packaged using a generated Kitfile.

In interactive settings, this command will read the EDITOR environment variable
to determine which editor should be used for editing the Kitfile.

Note: importing repositories requires 'git' and 'git-lfs' to be installed.

```
kit import [flags] REPOSITORY
Expand All @@ -158,11 +163,11 @@ kit import [flags] REPOSITORY
### Examples

```
# Download repository myorg/myrepo and package it, using the default tag
# Download repository myorg/myrepo and package it, using the default tag (myorg/myrepo:latest)
kit import myorg/myrepo

# Download repository and tag it 'myrepository:latest'
kit import myorg/myrepo --tag myrepository:latest
# Download repository and tag it 'myrepository:mytag'
kit import myorg/myrepo --tag myrepository:mytag
```

### Options
Expand Down
18 changes: 12 additions & 6 deletions pkg/cmd/kitimport/cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,21 @@ import (
const (
shortDesc = `Import a model from HuggingFace`
longDesc = `Download a repository from HuggingFace and package it as a ModelKit.

The repository will be downloaded to a temporary directory and be packaged using a
generated Kitfile.`

example = `# Download repository myorg/myrepo and package it, using the default tag
The repository can be specified either via a repository (e.g. myorg/myrepo) or
with a full URL (https://huggingface.co/myorg/myrepo). The repository will be
downloaded to a temporary directory and be packaged using a generated Kitfile.

In interactive settings, this command will read the EDITOR environment variable
to determine which editor should be used for editing the Kitfile.

Note: importing repositories requires 'git' and 'git-lfs' to be installed.`

example = `# Download repository myorg/myrepo and package it, using the default tag (myorg/myrepo:latest)
kit import myorg/myrepo

# Download repository and tag it 'myrepository:latest'
kit import myorg/myrepo --tag myrepository:latest`
# Download repository and tag it 'myrepository:mytag'
kit import myorg/myrepo --tag myrepository:mytag`
)

var repoToTagRegexp = regexp.MustCompile(`^.*?([0-9A-Za-z_-]+/[0-9A-Za-z_-]+)[^/]*$`)
Expand Down