Skip to content

Commit

Permalink
Merge branch 'rft-more-linting' of https://github.com/gohypermode/docs
Browse files Browse the repository at this point in the history
…into rft-more-linting
  • Loading branch information
ryanfoxtyler committed Apr 6, 2024
2 parents de2e4fa + 6db89c4 commit 845c8e0
Show file tree
Hide file tree
Showing 13 changed files with 21 additions and 16 deletions.
6 changes: 3 additions & 3 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"MD013": false,
"MD033": false
}
"MD013": false,
"MD033": false
}
2 changes: 1 addition & 1 deletion define-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ AI models are a core resource for inferencing. The [project manifest](/manifest)

## Auto-deployed models

When using `hugging-face` as the `provider` and `hypermode` as the `host`, Hypermode automatically deploys a dedicated instance of the defined `sourceModel` when deploying your project. Your project's functions securely connect to the hosted model, with no further configuration required.
When using `hugging-face` as the `provider` and `hypermode` as the `host`, Hypermode automatically deploys a dedicated instance of the defined `sourceModel` when deploying your project. Your project's functions securely connect to the hosted model, with no further configuration required.
2 changes: 1 addition & 1 deletion define-schema.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ type Query {

Hypermode follows [GraphQL's standard definition language](https://graphql.org/learn/schema/). Add your function signature and the [directive](https://graphql.org/learn/queries/#directives) `@lambda @hm_function` to register the function on the project's endpoint. The signature must match the exposed function in your `index.ts` file.

When deployed, your GraphQL API is available on the `/graphql` path from your project's endpoint. The endpoint is visible in the Hypermode Console on the Project Home screen.
When deployed, your GraphQL API is available on the `/graphql` path from your project's endpoint. The endpoint is visible in the Hypermode Console on the Project Home screen.
2 changes: 1 addition & 1 deletion deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ A GitHub Action is available in the [template project](https://github.com/gohype

On successful build of your project or a change to your manifest in your connected GitHub repository, Hypermode automatically deploys your project changes.

For [auto-deployed models](/define-models#auto-deployed-models), Hypermode deploys a dedicated instance of the model.
For [auto-deployed models](/define-models#auto-deployed-models), Hypermode deploys a dedicated instance of the model.
2 changes: 1 addition & 1 deletion function-observability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: ''

When you invoke a function within your project, the service records each execution. In addition to duration, logs are available for each execution to enable integrated debugging.

To access the run history, navigate to the Function Runs tab of your project within the Hypermode Console.
To access the run history, navigate to the Function Runs tab of your project within the Hypermode Console.
2 changes: 1 addition & 1 deletion introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Don't stop there. Launch your project quickly with a large language model, while
src="/images/architecture-dark.png"
alt="Hypermode's architecture, comprising three layers Functions, Functions SDK, and Runtime Services comprising the three layers."
/>
</Frame>
</Frame>
2 changes: 1 addition & 1 deletion manifest.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ The manifest in a Hypermode project allows you to configure the resources your f
>
Expose functions on your project's API endpoint
</Card>
</CardGroup>
</CardGroup>
2 changes: 1 addition & 1 deletion quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ mode: "wide"

Want to try a new model? Add a new entry to your manifest and update your function. It's that easy!
</Step>
</Steps>
</Steps>
3 changes: 2 additions & 1 deletion sdk/connection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Connection APIs allow you to securely access an API endpoint at a defined host.
<Tip>We're introducing new APIs consistently through ongoing development with build partners. [Let's chat](mailto:[email protected]) about what would make the Functions SDK even more powerful for your next use case!</Tip>

### invokeGraphqlApi

Make a query or mutation against a GraphQL API endpoint.

```TypeScript
Expand All @@ -28,4 +29,4 @@ invokeGraphqlApi (

<ResponseField name="variables" type="string">
Optional variables added to the query.
</ResponseField>
</ResponseField>
3 changes: 2 additions & 1 deletion sdk/console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Console APIs allow you to interact with the Hypermode Console.
<Tip>We're introducing new APIs consistently through ongoing development with build partners. [Let's chat](mailto:[email protected]) about what would make the Functions SDK even more powerful for your next use case!</Tip>

### log

Generate a log message for debugging at runtime.

```TypeScript
Expand All @@ -23,4 +24,4 @@ log (

<ResponseField name="level" type="string">
Severity of log message, one of `info` (default), `error`, `warning` or `debug`.
</ResponseField>
</ResponseField>
2 changes: 1 addition & 1 deletion sdk/functions-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ The Functions SDK gives your project access to a set of APIs that simplify the d

## Installation

The easiest way to start with Hypermode is using the [template project](https://github.com/gohypermode/template-project). This project includes the [AssemblyScript Library](https://www.npmjs.com/package/@hypermode/functions-as) from the SDK.
The easiest way to start with Hypermode is using the [template project](https://github.com/gohypermode/template-project). This project includes the [AssemblyScript Library](https://www.npmjs.com/package/@hypermode/functions-as) from the SDK.
7 changes: 5 additions & 2 deletions sdk/inference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Inference APIs allow you to invoke AI models defined in your project's [manifest
<Tip>We're introducing new APIs consistently through ongoing development with build partners. [Let's chat](mailto:[email protected]) about what would make the Functions SDK even more powerful for your next use case!</Tip>

### generateText

Invoke a generative AI model with an instruction and prompt, resulting in a text response.

```TypeScript
Expand All @@ -31,6 +32,7 @@ generateText (
</ResponseField>

### computeClassificationLabels

Invoke a fine-tuned classification model with a text input, resulting in an array of labels and probabilities.

```TypeScript
Expand All @@ -49,12 +51,13 @@ computeClassificationLabels (
</ResponseField>

### embedText

Invoke an embedding model with a text input, resulting in a vector embedding.

```TypeScript
embedText (
modelName: string,
text: string,
text: string,
): number
```

Expand All @@ -64,4 +67,4 @@ embedText (

<ResponseField name="text" type="string" required>
Text input for embedding.
</ResponseField>
</ResponseField>
2 changes: 1 addition & 1 deletion sdk/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ description: ''

<Tip>We're introducing new APIs consistently through ongoing development with build partners. [Let's chat](mailto:[email protected]) about what would make the Functions SDK even more powerful for your next use case!</Tip>

The [embedText](/sdk/inference#embedtext) API creates text embeddings for use in semantic similarity search use cases.
The [embedText](/sdk/inference#embedtext) API creates text embeddings for use in semantic similarity search use cases.

0 comments on commit 845c8e0

Please sign in to comment.