Skip to content

docs: move capabilities fields to correct location under config #139

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

Open
aftersnow wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −26
Open

docs: move capabilities fields to correct location under config #139

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
48 changes: 22 additions & 26 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,51 +135,47 @@ The following terms are used in this section:

Special capabilities that the model supports, such as reasoning, toolusage, etc.

- **modelfs** _object_, REQUIRED

Contains hashes of each uncompressed layer's content.
- **inputTypes** _array of string_, OPTIONAL

- **type** _string_, REQUIRED
An array of strings specifying the data types that the model can accept as input.
The allowed values are: "text", "image", "audio", "video", or "embedding". For input types that are not explicitly defined, the value "other" value should be used.

Must be set to "layers".
- **outputTypes** _array of string_, OPTIONAL

- **diffIds** _array of strings_, REQUIRED
An array of strings specifying the data types that the model can produce as output.
The allowed values are: "text", "image", "audio", "video", or "embedding". For output types that are not explicitly defined, the value "other" value should be used.

An array of layer content hashes (`DiffIDs`), in order from first to last.
- **knowledgeCutoff** _string_, OPTIONAL

- **capabilities** _object_, OPTIONAL
The date and time of the datasets that the model was trained on, formatted as defined by [RFC 3339, section 5.6][rfc3339-s5.6].

Special capabilities that the model supports, such as reasoning, toolusage, etc.
- **reasoning** _boolean_, OPTIONAL

- **inputTypes** _array of string_, OPTIONAL
Whether the model can perform reasoning tasks.

An array of strings specifying the data types that the model can accept as input.
The allowed values are: "text", "image", "audio", "video", or "embedding". For input types that are not explicitly defined, the value "other" value should be used.
- **toolUsage** _boolean_, OPTIONAL

- **outputTypes** _array of string_, OPTIONAL
Whether the model can use external tools or APIs to perform tasks.

An array of strings specifying the data types that the model can produce as output.
The allowed values are: "text", "image", "audio", "video", or "embedding". For output types that are not explicitly defined, the value "other" value should be used.
- **reward** _boolean_, OPTIONAL

- **knowledgeCutoff** _string_, OPTIONAL
Whether the model is a reward model.

The date and time of the datasets that the model was trained on, formatted as defined by [RFC 3339, section 5.6][rfc3339-s5.6].
- **languages** _array of string_, OPTIONAL

- **reasoning** _boolean_, OPTIONAL
What languages can the model speak. Encoded as [ISO 639][iso-639] two letter codes.

Whether the model can perform reasoning tasks.

- **toolUsage** _boolean_, OPTIONAL
- **modelfs** _object_, REQUIRED

Whether the model can use external tools or APIs to perform tasks.
Contains hashes of each uncompressed layer's content.

- **reward** _boolean_, OPTIONAL
- **type** _string_, REQUIRED

Whether the model is a reward model.
Must be set to "layers".

- **languages** _array of string_, OPTIONAL
- **diffIds** _array of strings_, REQUIRED

What languages can the model speak. Encoded as [ISO 639][iso-639] two letter codes.
An array of layer content hashes (`DiffIDs`), in order from first to last.

## Example

Expand Down