kit
ModelKit is an OCI-compliant packaging format, thatencapsulates datasets, code, docs, configurations, and model weights
into a single, standardized unit.
See kitops.ml for more information.
Uses the Kit CLI to pack, unpack, pull, push, and tag ModelKits.
Installation
dagger install github.com/jozu-ai/daggerverse/kit@v0.1.0
Entrypoint
Return Type
Kit !
Arguments
Name | Type | Description |
---|---|---|
registry | String | OCI registry |
plainHttp | Boolean | use plainHttp |
version | String | Kit version |
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
func (m *myModule) example() *Kit {
return dag.
Kit()
}
@function
def example() -> dag.Kit:
return (
dag.kit()
)
@func()
example(): Kit {
return dag
.kit()
}
Types
Kit 🔗
registry() 🔗
Return Type
String !
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
registry
func (m *myModule) example(ctx context.Context) string {
return dag.
Kit().
Registry(ctx)
}
@function
async def example() -> str:
return await (
dag.kit()
.registry()
)
@func()
async example(): Promise<string> {
return dag
.kit()
.registry()
}
plainHttp() 🔗
Return Type
Boolean !
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
plain-http
func (m *myModule) example(ctx context.Context) bool {
return dag.
Kit().
PlainHttp(ctx)
}
@function
async def example() -> bool:
return await (
dag.kit()
.plain_http()
)
@func()
async example(): Promise<boolean> {
return dag
.kit()
.plainHttp()
}
version() 🔗
Return Type
String !
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
version
func (m *myModule) example(ctx context.Context) string {
return dag.
Kit().
Version(ctx)
}
@function
async def example() -> str:
return await (
dag.kit()
.version()
)
@func()
async example(): Promise<string> {
return dag
.kit()
.version()
}
container() 🔗
Return Type
Container !
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
container
func (m *myModule) example() *Container {
return dag.
Kit().
Container()
}
@function
def example() -> dagger.Container:
return (
dag.kit()
.container()
)
@func()
example(): Container {
return dag
.kit()
.container()
}
withAuth() 🔗
Authenticates the user with the remote registry
Return Type
Kit !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
username | String ! | - | No description provided |
password | Secret ! | - | No description provided |
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
with-auth --username string --password env:MYSECRET
func (m *myModule) example(username string, password *Secret) *Kit {
return dag.
Kit().
WithAuth(username, password)
}
@function
def example(username: str, password: dagger.Secret) -> dag.Kit:
return (
dag.kit()
.with_auth(username, password)
)
@func()
example(username: string, password: Secret): Kit {
return dag
.kit()
.withAuth(username, password)
}
pack() 🔗
Packs a directory into a ModelKit
Return Type
Kit !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
directory | Directory ! | - | directory to pack |
reference | String ! | - | tag reference |
kitfile | File | - | the kitfile |
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
pack --directory DIR_PATH --reference string
func (m *myModule) example(directory *Directory, reference string) *Kit {
return dag.
Kit().
Pack(directory, reference)
}
@function
def example(directory: dagger.Directory, reference: str) -> dag.Kit:
return (
dag.kit()
.pack(directory, reference)
)
@func()
example(directory: Directory, reference: string): Kit {
return dag
.kit()
.pack(directory, reference)
}
unpack() 🔗
Unpacks a ModelKit into a directory
Return Type
Directory !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
reference | String ! | - | reference to the ModelKit |
filter | [String ! ] | - | the artifacts to unpack |
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
unpack --reference string
func (m *myModule) example(reference string) *Directory {
return dag.
Kit().
Unpack(reference)
}
@function
def example(reference: str) -> dagger.Directory:
return (
dag.kit()
.unpack(reference)
)
@func()
example(reference: string): Directory {
return dag
.kit()
.unpack(reference)
}
pull() 🔗
Pulls a ModelKit from the registry
Return Type
Kit !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
reference | String ! | - | No description provided |
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
pull --reference string
func (m *myModule) example(reference string) *Kit {
return dag.
Kit().
Pull(reference)
}
@function
def example(reference: str) -> dag.Kit:
return (
dag.kit()
.pull(reference)
)
@func()
example(reference: string): Kit {
return dag
.kit()
.pull(reference)
}
push() 🔗
Pushes a ModelKit to the registry
Return Type
Void !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
reference | String ! | - | No description provided |
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
push --reference string
func (m *myModule) example(ctx context.Context, reference string) {
return dag.
Kit().
Push(ctx, reference)
}
@function
async def example(reference: str) -> None:
return await (
dag.kit()
.push(reference)
)
@func()
async example(reference: string): Promise<void> {
return dag
.kit()
.push(reference)
}
tag() 🔗
Tags a ModelKit
Return Type
Kit !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
currentRef | String ! | - | No description provided |
newRef | String ! | - | No description provided |
Example
dagger -m github.com/jozu-ai/daggerverse/kit@a4e5e833af49ad44c91a94a28a2dfbafc5f49510 call \
tag --current-ref string --new-ref string
func (m *myModule) example(currentRef string, newRef string) *Kit {
return dag.
Kit().
Tag(currentRef, newRef)
}
@function
def example(current_ref: str, new_ref: str) -> dag.Kit:
return (
dag.kit()
.tag(current_ref, new_ref)
)
@func()
example(currentRef: string, newRef: string): Kit {
return dag
.kit()
.tag(currentRef, newRef)
}