Skip to content
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

docs(ai): enhance remote worker documentation and standardize template variables #701

Merged
merged 1 commit into from
Jan 21, 2025
Merged

docs(ai): enhance remote worker documentation and standardize template variables #701

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions ai/gateways/start-gateway.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Follow the steps below to start your Livepeer AI Gateway node:
livepeer/go-livepeer:master \
-datadir ~/.lpData2 \
-gateway \
-orchAddr <ORCH_LIST> \
-orchAddr <orchestrator list> \
-httpAddr 0.0.0.0:8937 \
-v 6 \
-httpIngest
Expand Down Expand Up @@ -79,7 +79,7 @@ Follow the steps below to start your Livepeer AI Gateway node:
./livepeer \
-datadir ~/.lpData2 \
-gateway \
-orchAddr <ORCH_LIST> \
-orchAddr <orchestrator list> \
-httpAddr 0.0.0.0:8937 \
-v 6 \
-httpIngest
Expand Down
17 changes: 8 additions & 9 deletions ai/orchestrators/ai-worker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,25 +56,24 @@ Below are the launch commands for both the Orchestrator and AI Worker nodes.
docker run \
--name livepeer_ai_orchestrator \
...
livepeer/go-livepeer:master \
-orchestrator \
...
-aiModels /root/.lpData/aiModels.json
-orchSecret <orchestrator secret>
-serviceAddr <orchestrator service address>
```

#### AI Worker Command

```bash
docker run \
--name livepeer_ai_worker \
...
livepeer/go-livepeer:master \
-aiWorker \
-orchAddr [Orchestrator service address] \
-orchSecret [Orchestrator secret key] \
-nvidia "all" \
-v 6 \
-aiModels /root/.lpData/aiModels.json \
-aiModelsDir /root/.lpData/models \
-testTranscoder=false \
-aiRunnerImage livepeer/ai-runner:latest # Optional
...
-orchSecret <orchestrator secret> \
-orchAddr <orchestrator service address>
```

<Info>
Expand Down
11 changes: 5 additions & 6 deletions ai/orchestrators/onchain.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Orchestrator node to redeem tickets:

```bash
./livepeer \
-ethOrchAddr <MAIN_ORCH_ADDRESS> \
-ethOrchAddr <main orch address> \
... \
```
</Step>
Expand Down Expand Up @@ -85,7 +85,7 @@ contract on the [Arbitrum Mainnet](https://arbitrum.io).
Set your Service URI, ensuring it starts with `https://`, using the `SetServiceURI` function on the [AIServiceRegistry](https://arbiscan.io/address/0x04C0b249740175999E5BF5c9ac1dA92431EF34C5) contract. Use the KeyStore file and password from your **Mainnet Transcoding Network Orchestrator** wallet:

```bash
cast send --keystore '<PATH_TO_KEYSTORE_FILE>' --password '<PASSWORD>' --rpc-url <ARBITRUM_RPC_URI> 0x04C0b249740175999E5BF5c9ac1dA92431EF34C5 "setServiceURI(string)" https://<PUBLIC_ORCH_IP_OR_URL>:<PUBLIC_ORCH_PORT>
cast send --keystore '<path to keystore>' --password '<password>' --rpc-url <arbitrum RPC URI> 0x04C0b249740175999E5BF5c9ac1dA92431EF34C5 "setServiceURI(string)" https://<public orch URI>:<public orch port>
```

After successful execution, the output should look like this:
Expand All @@ -99,13 +99,13 @@ contract on the [Arbitrum Mainnet](https://arbitrum.io).
Verify your Service URI by invoking the `getServiceURI` function on the [AIServiceRegistry](https://arbiscan.io/address/0x04C0b249740175999E5BF5c9ac1dA92431EF34C5) contract:

```bash
cast call --rpc-url <ARBITRUM_RPC_URI> 0x04C0b249740175999E5BF5c9ac1dA92431EF34C5 "getServiceURI(address)" <PUBLIC_WALLET_KEY> | xxd -r -p
cast call --rpc-url <arbitrum RPC URI> 0x04C0b249740175999E5BF5c9ac1dA92431EF34C5 "getServiceURI(address)" <public wallet key> | xxd -r -p
```

If successful, the output should be:

```bash
https://<PUBLIC_ORCH_IP_OR_URL>:<PUBLIC_ORCH_PORT>
https://<public orch URI>:<public orch port>
```
</Step>
</Steps>
Expand Down Expand Up @@ -157,8 +157,7 @@ network. The commands to start the AI Orchestrator are similar to those for the
[off-chain Orchestrator](/ai/orchestrators/start-orchestrator), but with
additional flags to enable on-chain functionality:

- `-AIServiceRegistry`: Ensures that the Gateway is connected to the Livepeer AI
network.
- `-AIServiceRegistry`: Ensures that the Orchestrator is connected to the Livepeer AI network.
- `-network=arbitrum-one-mainnet`: Connects the AI Orchestrator node to the
Arbitrum Mainnet network.
- `-ethUrl=https://arb1.arbitrum.io/rpc`: Sets the Arbitrum Mainnet RPC URL. You
Expand Down
Loading