diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..7538147 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,37 @@ +name: Lint + +on: + push: + branches: [main, release-*] + pull_request: + branches: [main, release-*] + +permissions: + contents: read + +jobs: + lint: + name: Lint + runs-on: ubuntu-latest + timeout-minutes: 30 + steps: + - name: Checkout code + uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 + + - uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 + with: + go-version-file: specs-go/go.mod + cache: false + + - name: Golangci lint + uses: golangci/golangci-lint-action@aaa42aa0628b4ae2578232a66b541047968fac86 + with: + version: v1.54 + args: --verbose + working-directory: specs-go + + - name: Markdown lint + uses: docker://avtodev/markdown-lint:v1@sha256:6aeedc2f49138ce7a1cd0adffc1b1c0321b841dc2102408967d9301c031949ee + with: + config: '.markdownlint.yml' + args: '**/*.md' diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..71cce7a --- /dev/null +++ b/.gitignore @@ -0,0 +1,56 @@ +# Binaries for programs and plugins +*.exe +*.exe~ + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +vendor/ +.idea +.vscode +.cache +*.DS_Store +target/ +scheduler/test/misc +manager/dist/* +!manager/dist/.gitkeep +.chglog + +# vscode +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk diff --git a/.golangci.yml b/.golangci.yml new file mode 100644 index 0000000..e2e5778 --- /dev/null +++ b/.golangci.yml @@ -0,0 +1,37 @@ +run: + deadline: 3m + modules-download-mode: readonly + +linters-settings: + gocyclo: + min-complexity: 100 + gci: + sections: + - standard + - default + +issues: + new: true + exclude-rules: + - linters: + - staticcheck + text: "SA1019:" + +linters: + disable-all: true + enable: + - gci + - gofmt + - golint + - misspell + - govet + - goconst + - deadcode + - gocyclo + - staticcheck + - errcheck + +output: + format: colored-line-number + print-issued-lines: true + print-linter-name: true diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 0000000..abd9eec --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,6 @@ +MD010: false + +MD013: false + +MD046: + style: "fenced" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000..d65c4df --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,10 @@ +# Maintainers + +| GitHub ID | Name | Email | Company | +| :-----------------------------------------: | :----------: | :----------------------: | :-------: | +| [bergwolf](https://github.com/bergwolf) | Tao Peng | bergwolf@hyper.sh | Ant Group | +| [aftersnow](https://github.com/aftersnow) | Chen Zhao | zhaochen.zju@gmail.com | Ant Group | +| [steven-zou](https://github.com/steven-zou) | Steven Zou | loneghost1982@gmail.com | Broadcom | +| [wy65701436](https://github.com/wy65701436) | Yan Wang | wangyan_0219@hotmail.com | Broadcom | +| [chlins](https://github.com/chlins) | Chenyu Zhang | chlins.zhang@gmail.com | Ant Group | +| [gaius-qi](https://github.com/gaius-qi) | Gaius Qi | gaius.qi@gmail.com | Ant Group | diff --git a/README.md b/README.md new file mode 100644 index 0000000..494ce2b --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# CNAI Model Format Specification + +[![LICENSE](https://img.shields.io/github/license/CloudNativeAI/model-spec.svg?style=flat-square)](https://github.com/CloudNativeAI/model-spec/blob/main/LICENSE) +[![GoDoc](https://godoc.org/github.com/CloudNativeAI/model-spec?status.svg)](https://godoc.org/github.com/CloudNativeAI/model-spec) + +The Cloud Native Artifacial Intelegence(CNAI) Model Format Specification is a specification for a model format that is designed to be used in cloud native environments. + +For details, see the [specification](docs/v1/spec.md). + +## LICENSE + +Apache 2.0 License. Please see [LICENSE](LICENSE) for more information. diff --git a/docs/v1/annotations.md b/docs/v1/annotations.md new file mode 100644 index 0000000..216f553 --- /dev/null +++ b/docs/v1/annotations.md @@ -0,0 +1,36 @@ +# Annotations + +This property contains arbitrary metadata, and SHOULD follow the rules of [OCI image annotations](https://github.com/opencontainers/image-spec/blob/main/annotations.md). + +## Pre-defined Annotation Keys + +### Manifest Annotation Keys + +#### Model-common Annotation Keys + +- **`org.cnai.model.created`**: Date and time on which the image was built, conforming to [RFC 3339](https://tools.ietf.org/html/rfc3339#section-5.6). +- **`org.cnai.model.authors`**: Contact details of the people or organization responsible for the model (freeform string). +- **`org.cnai.model.url`**: URL to find more information on the model (string). +- **`org.cnai.model.documentation`**: URL to get documentation on the model (string). +- **`org.cnai.model.source`**: URL to get source code for building the model (string). +- **`org.cnai.model.version`**: Version of the model. +- **`org.cnai.model.revision`**: Source control revision identifier for the model. +- **`org.cnai.model.vendor`**: Name of the distributing entity, organization or individual. +- **`org.cnai.model.licenses`**: License(s) under which contained software is distributed as an [SPDX License Expression](https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions/). +- **`org.cnai.model.ref.name`**: Name of the reference for a target (string). +- **`org.cnai.model.title`**: Human-readable title of the model (string). +- **`org.cnai.model.description`**: Human-readable description of the software packaged in the model (string). + +#### Model-specific Annotation Keys + +- **`org.cnai.model.architecture`**: Model architecture (string), such as `transformer`, `cnn`, `rnn`, etc. +- **`org.cnai.model.family`**: Model family (string), such as `llama3`, `gpt2`, `qwen2`, etc. +- **`org.cnai.model.name`**: Model name (string), such as `llama3-8b-instruct`, `gpt2-xl`, `qwen2-vl-72b-instruct`, etc. +- **`org.cnai.model.format`**: Model format (string), such as `onnx`, `tensorflow`, `pytorch`, etc. +- **`org.cnai.model.param.size`**: Number of parameters in the model (integer). +- **`org.cnai.model.precision`**: Model precision (string), such as `bf16`, `fp16`, `int8`, etc. +- **`org.cnai.model.quantization`**: Model quantization (string), such as `awq`, `gptq`, etc. + +### Layer Annotation Keys + +- **`org.cnai.model.readme`**: Specifies the layer is a README.md file (boolean), such as `true` or `false`. diff --git a/docs/v1/spec.md b/docs/v1/spec.md new file mode 100644 index 0000000..9939957 --- /dev/null +++ b/docs/v1/spec.md @@ -0,0 +1,69 @@ +# Model Specification + +This specification defines an open standard Artifacial Intelegence model, which is based on the [Image Format Specification](https://github.com/opencontainers/image-spec/blob/main/spec.md#image-format-specification). + +The goal of this specification is to package models in an OCI artifact to take advantage of OCI distribution and ensure efficient model deployment. + +The model specification needs to consider two factors: + +1. The model needs to be stored in the OCI registry and display the parameters of the model. So that the model should use + the [artifact extension](https://github.com/opencontainers/image-spec/blob/main/artifacts-guidance.md) to + packaging content other than OCI image specification. +2. The model needs to be mounted by the container runtime as + [read only volumes based on the OCI Artifacts in Kubernetes 1.31+](https://kubernetes.io/blog/2024/08/16/kubernetes-1-31-image-volume-source/). + Container runtimes can only pull OCI artifact that follows the OCI image specification. + +Therefore, the model specification must be defined through the artifact extension based on the [OCI image specification](https://github.com/opencontainers/image-spec/blob/main/spec.md#image-format-specification). It can be better compatible with the kubernetes ecosystem. + +## Overview + +The model specification is defined through the artifact extension based on the OCI image specification, and extend model features through `artifactType` and `annotations`. Model storage and distribution can be optimized based on artifact extension. + +![manifest](../../img/v1/manifest.svg) + +## Workflow + +The model specification running workflow is divided into two stages: `BUILD & PUSH` and `PULL & SERVE`. + +### BUILD & PUSH + +Use tools(ORAS, Ollama, etc.) to build required resources in the model repository into artifact based on the model specification. Note that the model layer MUST NOT be compressed, because the files of model weight has been compressed. If the model layer is compressed, the container runtime will cost long time to decompress the model layer. Therefore, it's recommended to use the `application/vnd.oci.image.layer.v1.tar` format for the model layer to avoid compression + +Next push the artifact to the OCI registry(Harbor, Docker Hub, etc.), and use the functionalities of the OCI registry to manage the model artifact. + +![build-push](../../img/v1/build-and-push.png) + +### PULL & SERVE + +The container runtime(containerd, cri-o, etc) pulls the model artifact from the OCI registry, and mounts the model artifact as a read-only volume. Therefore, distributed model can use the P2P technology(Dragonfly, Kraken, etc) to reduce the pressure on the registry and preheat the model artifact into each node. If the model artifact is already present on the node, the container runtime can reuse the model artifact to mount different containers in the same node. + +![pull-serve](../../img/v1/pull-and-serve.png) + +## Understanding the Specification + +The model specification is based on the [OCI image specification](https://github.com/opencontainers/image-spec/blob/main/spec.md) and focuses on defining the artifact extension according to the [Artifacts Guidance](https://github.com/opencontainers/image-spec/blob/main/artifacts-guidance.md). + +### Image Manifest Extension Properties + +- **`artifactType`** _string_ + + This REQUIRED property MUST contain the media type `application/vnd.cnai.model.manifest.v1+json`. + +- **`layers`** _array of objects_ + + - **`artifactType`** _string_ + + Implementations MUST support at least the following media types: + + - `application/vnd.cnai.model.layer.v1.tar` + - `application/vnd.cnai.model.layer.v1.tar+gzip` + + If `mediaType` is `application/vnd.oci.image.layer.v1.tar`, the `artifactType` MUST be `application/vnd.cnai.model.layer.v1.tar`. If `mediaType` is `application/vnd.oci.image.layer.v1.tar+gzip`, the `artifactType` MUST be `application/vnd.cnai.model.layer.v1.tar+gzip`. The `mediaType` and `artifactType` MUST be consistent, for detailed definitions of Filesystem Layers, please refer to the [Image Layer Filesystem Changeset](https://github.com/opencontainers/image-spec/blob/main/layer.md). + + - **`annotations`** _string-string map_ + + This OPTIONAL property contains arbitrary metadata for the layer. For model specification, SHOULD set the pre-defined annotation keys, refer to the [Layer Annotation Keys](./annotations.md#layer-annotation-keys). + +- **`annotations`** _string-string map_ + + This OPTIONAL property contains arbitrary metadata for the image manifest. For model specification, SHOULD set the pre-defined annotation keys, refer to the [Manifest Annotation Keys](./annotations.md#manifest-annotation-keys). diff --git a/img/v1/build-and-push.png b/img/v1/build-and-push.png new file mode 100644 index 0000000..c0111d5 Binary files /dev/null and b/img/v1/build-and-push.png differ diff --git a/img/v1/manifest.svg b/img/v1/manifest.svg new file mode 100644 index 0000000..9536478 --- /dev/null +++ b/img/v1/manifest.svg @@ -0,0 +1,4 @@ + + + +
{
  "schemaVersion": 2,
  "mediaType": "application/vnd.oci.image.manifest.v1+json",
  "artifactType": "application/vnd.cncf.cnai.model.manifest.v1+json",
  "annotations": {
    "org.cnai.model.foramt.name": "safetensors",
    "org.cnai.model.format.version": "0.4.5",
    ...
  }
  "layers": [
    {
      "mediaType": "application/vnd.oci.image.layer.v1.tar",
      "artifactType": "application/vnd.cncf.cnai.model.layer.v1.tar",
      "digest": "sha256:3f4d90098f5b5a6f6a76e9d...",
      "size": 2219949
    },
    {
      "mediaType": "application/vnd.oci.image.layer.v1.tar",
      "artifactType": "application/vnd.cncf.cnai.model.layer.v1.tar",
      "digest": "sha256:760cd441450d65fb33710ad...",
      "size": 10865
    },
    {
      "mediaType": "application/vnd.oci.image.layer.v1.tar",
      "artifactType": "application/vnd.cncf.cnai.model.layer.v1.tar",
      "digest": "sha256:10ff7ae0a5c3a62cb7a36f6...",
      "size": 165
    },
    ...
  ]
}
{...
/model-001-of-002.safetensors
/model-002-of-002.safetensors
/model.safetensors.index.json
/tokenizer_config.json
/...
/model-001-of-002.safetensors...
Read Only Volumes based on OCI Artifacts
Read Only Volumes based on OCI Artifacts \ No newline at end of file diff --git a/img/v1/pull-and-serve.png b/img/v1/pull-and-serve.png new file mode 100644 index 0000000..e69347e Binary files /dev/null and b/img/v1/pull-and-serve.png differ diff --git a/specs-go/go.mod b/specs-go/go.mod new file mode 100644 index 0000000..65fa1fc --- /dev/null +++ b/specs-go/go.mod @@ -0,0 +1,3 @@ +module github.com/CloudNativeAI/model-spec/specs-go + +go 1.22.4 diff --git a/specs-go/v1/annotations.go b/specs-go/v1/annotations.go new file mode 100644 index 0000000..d60ea55 --- /dev/null +++ b/specs-go/v1/annotations.go @@ -0,0 +1,86 @@ +/* + * Copyright 2024 The CNAI Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package v1 + +const ( + // AnnotationCreated is the annotation key for the date and time on which the model was built (date-time string as defined by RFC 3339). + AnnotationCreated = "org.cnai.model.created" + + // AnnotationAuthors is the annotation key for the contact details of the people or organization responsible for the model (freeform string). + AnnotationAuthors = "org.cnai.model.authors" + + // AnnotationURL is the annotation key for the URL to find more information on the model. + AnnotationURL = "org.cnai.model.url" + + // AnnotationDocumentation is the annotation key for the URL to get documentation on the model. + AnnotationDocumentation = "org.cnai.model.documentation" + + // AnnotationSource is the annotation key for the URL to get source code for building the model. + AnnotationSource = "org.cnai.model.source" + + // AnnotationVersion is the annotation key for the version of the packaged software. + // The version MAY match a label or tag in the source code repository. + // The version MAY be Semantic versioning-compatible. + AnnotationVersion = "org.cnai.model.version" + + // AnnotationRevision is the annotation key for the source control revision identifier for the packaged software. + AnnotationRevision = "org.cnai.model.revision" + + // AnnotationVendor is the annotation key for the name of the distributing entity, organization or individual. + AnnotationVendor = "org.cnai.model.vendor" + + // AnnotationLicenses is the annotation key for the license(s) under which contained software is distributed as an SPDX License Expression. + AnnotationLicenses = "org.cnai.model.licenses" + + // AnnotationRefName is the annotation key for the name of the reference for a target. + // SHOULD only be considered valid when on descriptors on `index.json` within model layout. + AnnotationRefName = "org.cnai.model.ref.name" + + // AnnotationTitle is the annotation key for the human-readable title of the model. + AnnotationTitle = "org.cnai.model.title" + + // AnnotationDescription is the annotation key for the human-readable description of the software packaged in the model. + AnnotationDescription = "org.cnai.model.description" +) + +const ( + // AnnotationArchitecture is the annotation key for the model architecture, such as `transformer`, `cnn`, `rnn`, etc. + AnnotationArchitecture = "org.cnai.model.architecture" + + // AnnotationFamily is the annotation key for the model family, such as `llama3`, `gpt2`, `qwen2`, etc. + AnnotationFamily = "org.cnai.model.family" + + // AnnotationName is the annotation key for the model name, such as `llama3-8b-instruct`, `gpt2-xl`, `qwen2-vl-72b-instruct`, etc. + AnnotationName = "org.cnai.model.name" + + // AnnotationFormat is the annotation key for the model format, such as `onnx`, `tensorflow`, `pytorch`, etc. + AnnotationFormat = "org.cnai.model.format" + + // AnnotationParamSize is the annotation key for the size of the model parameters. + AnnotationParamSize = "org.cnai.model.param.size" + + // AnnotationPrecision is the annotation key for the model precision, such as `bf16`, `fp16`, `int8`, etc. + AnotationPrecision = "org.cnai.model.precision" + + // AnnotationQuantization is the annotation key for the model quantization, such as `awq`, `gptq`, etc. + AnotationQuantization = "org.cnai.model.quantization" +) + +const ( + // AnnotationReadme is the annotation key for the layer is a README.md file (boolean), such as `true` or `false`. + AnnotationReadme = "org.cnai.model.readme" +) diff --git a/specs-go/v1/mediatype.go b/specs-go/v1/mediatype.go new file mode 100644 index 0000000..2114eff --- /dev/null +++ b/specs-go/v1/mediatype.go @@ -0,0 +1,31 @@ +/* + * Copyright 2024 The CNAI Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package v1 + +const ( + // ArtifactTypeModelManifest specifies the media type for a model manifest. + ArtifactTypeModelManifest = "application/vnd.cnai.model.manifest.v1+json" +) + +const ( + // ArtifactTypeModelLayer is the media type used for layers referenced by the manifest. + ArtifactTypeModelLayer = "application/vnd.cnai.model.layer.v1.tar" + + // ArtifactTypeModelLayerGzip is the media type used for gzipped layers + // referenced by the manifest. + ArtifactTypeModelLayerGzip = "application/vnd.cnai.model.layer.v1.tar+gzip" +)