models

Author: ryanfoxtyler

modus/sdk/models.mdx

@@ -10,66 +10,55 @@ Since many models have unique interfaces, the design of the Models API is extrem
 common base class forms the core of the API, which extends to conform to any model's required
 schema.
 
-A separate library, [`models-as`](https://github.com/hypermodeinc/models-as) contains both the base
-classes and pre-defined implementations for many commonly used models. You can either use one of the
-pre-defined classes, or can create custom classes for any model you like, by extending from the base
-`Model` class.
+The SDK contains both the base classes and pre-defined implementations for many commonly used
+models. You can either use one of the pre-defined classes, or can create custom classes for any
+model you like, by extending from the base `Model` class.
 
-## Example project
-
-For your reference, several complete examples for using the Models API are available on GitHub in
-the `hypermodeinc/functions-as` repository:
-
-- [/examples/classification](https://github.com/hypermodeinc/modus/tree/main/sdk/assemblyscript/examples/classification)
-- [/examples/embedding](https://github.com/hypermodeinc/modus/tree/main/sdk/assemblyscript/examples/embedding)
-- [/examples/textgeneration](https://github.com/hypermodeinc/modus/tree/main/sdk/assemblyscript/examples/textgeneration)
+<Tip>
+For your reference, several complete examples for using the Models API are available in
+[Model Invoking](/modus/model-invoking).
 
 Each example demonstrates using different types of AI models for different purposes. However, the
 Models interface isn't limited to these purposes. You can use it for any task that an AI model can
 perform.
 
-<Note>
-  Currently, the models interface doesn't support streaming data, either for input or output. For
-  example, you can't use it with models that process streaming audio or video, nor provide streaming
-  text output. We plan to address this limitation in a future release.
-</Note>
+</Tip>
 
 ## Import
 
 To begin, import the `models` namespace from the SDK:
 
-<CodeGroup>
-
-```go Go
-import github.com/hypermodeinc/modus/sdk/go/pkg/models
-```
+<Tabs>
+  <Tab title="Go">
+    ```go
+    import github.com/hypermodeinc/modus/sdk/go/pkg/models
+    ```
 
-```ts AssemblyScript
-import { models } from "@hypermode/modus-sdk-as"
-```
+    You'll also need to import one or more classes for the model you are working with. For example:
 
-</CodeGroup>
+    ```go
+    import github.com/hypermodeinc/modus/sdk/go/pkg/models/experimental
+    ```
 
-You'll also need to import one or more classes for the model you are working with.
+  </Tab>
 
-For example:
+  <Tab title="AssemblyScript">
+    ```ts
+    import { models } from "@hypermode/modus-sdk-as"
+    ```
 
-<CodeGroup>
+    You'll also need to import one or more classes for the model you are working with. For example:
 
-```ts AssemblyScript
-import { ClassificationModel } from "@hypermode/models-as/models/experimental/classification"
-```
+    ```ts
+    import { ClassificationModel } from "@hypermode/models-as/models/experimental/classification"
+    ```
 
-Refer to the
-[`hypermodeinc/models-as`](https://github.com/hypermodeinc/models-as/tree/main/src/models)
-repository for the full list of available models. We're constantly adding new models, so the list
-may have grown since you last checked.
+  </Tab>
+</Tabs>
 
 If you would like to request a new model, please
-[open an issue](https://github.com/hypermodeinc/models-as/issues) on the `models-as` repository. You
-can also send a pull request, if you'd like to contribute a new model yourself.
-
-</CodeGroup>
+[open an issue](https://github.com/hypermodeinc/modus/issues). You can also send a pull request, if
+you'd like to contribute a new model yourself.
 
 ## Models APIs
 
@@ -89,9 +78,9 @@ The APIs in the `models` namespace are below, organized by category.
 
 Get a model instance by name and type.
 
-```go
-models.getModel<T>(modelName: string): T
-```
+    ```go
+    models.getModel<T>(modelName: string): T
+    ```
 
 <ResponseField name="T" type="Type" required>
   The type of model to return. This can be any class that extends the `Model` base class.
@@ -106,13 +95,13 @@ models.getModel<T>(modelName: string): T
 
 #### Model
 
-```go
-abstract class Model<TInput, TOutput> {
-  debug: boolean;
-  info: ModelInfo;
-  invoke(input: TInput): TOutput;
-}
-```
+    ```go
+    abstract class Model<TInput, TOutput> {
+      debug: boolean;
+      info: ModelInfo;
+      invoke(input: TInput): TOutput;
+    }
+    ```
 
 The base class for all models that Hypermode functions can invoke.
 
@@ -150,18 +139,18 @@ The base class for all models that Hypermode functions can invoke.
 
 #### ModelInfo
 
-```go
-class ModelInfo {
-  readonly name: string;
-  readonly fullName: string;
-}
-```
+    ```go
+    class ModelInfo {
+      readonly name: string;
+      readonly fullName: string;
+    }
+    ```
 
 Information about a model that's used to construct a `Model` instance. It's also available as a
 property on the `Model` class.
 
 <Info>
-  This class relays information from the Hypermode Runtime to the model implementation. Generally, you don't need to
+  This class relays information from the Modus runtime to the model implementation. Generally, you don't need to
   create `ModelInfo` instances directly.
 
 However, if you are implementing a custom model, you may wish to use a property from this class,
@@ -172,7 +161,7 @@ We may add additional properties to this class in the future, as needed.
 </Info>
 
 <ResponseField name="name" type="string">
-  The name of the model from the Hypermode manifest.
+  The name of the model from the app manifest.
 </ResponseField>
 
 <ResponseField name="fullName" type="string">

styles/config/vocabularies/general/accept.txt

@@ -45,7 +45,7 @@ queryScalar
 repo
 REST
 Scattergories
-SDK
+SDK|sdk
 serializable
 [Ss]erverless
 timeEnd