Skip to content

Commit

Permalink
chore(spelling-fixes): docs (elizaOS#2669)
Browse files Browse the repository at this point in the history
* Update DatabaseAdapter.md

* Update composeContext.md

* Update verified-inference.md

* Update README.md

---------

Co-authored-by: Sayo <[email protected]>
  • Loading branch information
nnsW3 and wtfsayo authored Jan 22, 2025
1 parent 27acd7b commit 5347b1f
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ pnpm clean

Once the agent is running, you should see the message to run "pnpm start:client" at the end.

Open another terminal, move to same directory, run the command below, then follow the URL to chat with your agent.
Open another terminal, move to the same directory, run the command below, then follow the URL to chat with your agent.

```bash
pnpm start:client
Expand Down
4 changes: 2 additions & 2 deletions docs/api/classes/DatabaseAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ like accounts, memories, actors, goals, and rooms.

> **new DatabaseAdapter**\<`DB`\>(`circuitBreakerConfig`?): [`DatabaseAdapter`](DatabaseAdapter.md)\<`DB`\>
Creates a new DatabaseAdapter instance with optional circuit breaker configuration.
Creates a new DatabaseAdapter instance with an optional circuit breaker configuration.

#### Parameters

Expand Down Expand Up @@ -69,7 +69,7 @@ The database instance.

> `protected` **circuitBreaker**: `CircuitBreaker`
Circuit breaker instance used to handle fault tolerance and prevent cascading failures.
Circuit breaker instance are used to handle fault tolerance and prevent cascading failures.
Implements the Circuit Breaker pattern to temporarily disable operations when a failure threshold is reached.

The circuit breaker has three states:
Expand Down
4 changes: 2 additions & 2 deletions docs/api/functions/composeContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The state object contains values to replace the placeholders in the template.

**params.template**: `string` | `Function`

The template string or function returning a string containing placeholders to be replaced with state values.
The template string or function returns a string containing placeholders to be replaced with state values.

**params.templatingEngine?**: `"handlebars"`

Expand All @@ -34,7 +34,7 @@ The templating engine to use for compiling and evaluating the template (optional

`string`

The composed context string with placeholders replaced by corresponding state values.
The composed context string with placeholders is replaced by corresponding state values.

## Example

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/advanced/verified-inference.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ sidebar_position: 18

## Overview

With verified inference, you can turn your Eliza agent fully verifiable on-chain on Solana with an OpenAI compatible TEE API. This proves that your agent’s thoughts and outputs are free from human control thus increasing the trust of the agent.
With verified inference, you can turn your Eliza agent fully verifiable on-chain on Solana with an OpenAI-compatible TEE API. This proves that your agent’s thoughts and outputs are free from human control thus increasing the trust of the agent.

Compared to [fully deploying the agent in a TEE](https://elizaos.github.io/eliza/docs/advanced/eliza-in-tee/), this is a more light-weight solution which only verifies the inference calls and only needs a single line of code change.

The API supports all OpenAI models out of the box, including your fine-tuned models. The following guide will walk you through how to use verified inference API with Eliza.

## Background

The API is built on top of [Sentience Stack](https://github.com/galadriel-ai/Sentience), which cryptographically verifies agent's LLM inferences inside TEEs, posts those proofs on-chain on Solana, and makes the verified inference logs available to read and display to users.
The API is built on top of [Sentience Stack](https://github.com/galadriel-ai/Sentience), which cryptographically verifies the agent's LLM inferences inside TEEs, posts those proofs on-chain on Solana, and makes the verified inference logs available to read and display to users.

Here’s how it works:
![](https://i.imgur.com/SNwSHam.png)
Expand All @@ -23,7 +23,7 @@ Here’s how it works:
2. The TEE securely processes the request by calling the LLM API.
3. The TEE sends back the `{Message, Proof}` to the agent.
4. The TEE submits the attestation with `{Message, Proof}` to Solana.
5. The Proof of Sentience SDK is used to read the attestation from Solana and verify it with `{Message, Proof}`. The proof log can be added to the agent website/app.
5. The Proof of Sentience SDK is used to read the attestation from Solana and verify it with `{Message, Proof}`. The proof log can be added to the agent's website/app.

To verify the code running inside the TEE, use instructions [from here](https://github.com/galadriel-ai/sentience/tree/main/verified-inference/verify).

Expand All @@ -48,7 +48,7 @@ To verify the code running inside the TEE, use instructions [from here](https://
```
4. **Run your agent.**

Reminder how to run an agent is [here](https://elizaos.github.io/eliza/docs/quickstart/#create-your-first-agent).
Reminder of how to run an agent is [here](https://elizaos.github.io/eliza/docs/quickstart/#create-your-first-agent).
```bash
pnpm start --character="characters/<your_character>.json"
pnpm start:client
Expand Down

0 comments on commit 5347b1f

Please sign in to comment.