Skip to content

Commit b001989

Browse files
committed
docs(ai): enhance remote worker documentation and standardize template variables
This commit improves the clarity and usability of the remote worker documentation by providing expanded and more detailed instructions. Additionally, it ensures consistent usage of template variables across the AI documentation for better readability and uniformity.
1 parent 0567f6f commit b001989

File tree

3 files changed

+15
-17
lines changed

3 files changed

+15
-17
lines changed

ai/gateways/start-gateway.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Follow the steps below to start your Livepeer AI Gateway node:
3333
livepeer/go-livepeer:master \
3434
-datadir ~/.lpData2 \
3535
-gateway \
36-
-orchAddr <ORCH_LIST> \
36+
-orchAddr <orchestrator list> \
3737
-httpAddr 0.0.0.0:8937 \
3838
-v 6 \
3939
-httpIngest
@@ -79,7 +79,7 @@ Follow the steps below to start your Livepeer AI Gateway node:
7979
./livepeer \
8080
-datadir ~/.lpData2 \
8181
-gateway \
82-
-orchAddr <ORCH_LIST> \
82+
-orchAddr <orchestrator list> \
8383
-httpAddr 0.0.0.0:8937 \
8484
-v 6 \
8585
-httpIngest

ai/orchestrators/ai-worker.mdx

+8-9
Original file line numberDiff line numberDiff line change
@@ -56,25 +56,24 @@ Below are the launch commands for both the Orchestrator and AI Worker nodes.
5656
docker run \
5757
--name livepeer_ai_orchestrator \
5858
...
59+
livepeer/go-livepeer:master \
5960
-orchestrator \
6061
...
61-
-aiModels /root/.lpData/aiModels.json
62+
-orchSecret <orchestrator secret>
63+
-serviceAddr <orchestrator service address>
6264
```
6365

6466
#### AI Worker Command
6567

6668
```bash
6769
docker run \
6870
--name livepeer_ai_worker \
71+
...
72+
livepeer/go-livepeer:master \
6973
-aiWorker \
70-
-orchAddr [Orchestrator service address] \
71-
-orchSecret [Orchestrator secret key] \
72-
-nvidia "all" \
73-
-v 6 \
74-
-aiModels /root/.lpData/aiModels.json \
75-
-aiModelsDir /root/.lpData/models \
76-
-testTranscoder=false \
77-
-aiRunnerImage livepeer/ai-runner:latest # Optional
74+
...
75+
-orchSecret <orchestrator secret> \
76+
-orchAddr <orchestrator service address>
7877
```
7978

8079
<Info>

ai/orchestrators/onchain.mdx

+5-6
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Orchestrator node to redeem tickets:
4141

4242
```bash
4343
./livepeer \
44-
-ethOrchAddr <MAIN_ORCH_ADDRESS> \
44+
-ethOrchAddr <main orch address> \
4545
... \
4646
```
4747
</Step>
@@ -85,7 +85,7 @@ contract on the [Arbitrum Mainnet](https://arbitrum.io).
8585
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:
8686

8787
```bash
88-
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>
88+
cast send --keystore '<path to keystore>' --password '<password>' --rpc-url <arbitrum RPC URI> 0x04C0b249740175999E5BF5c9ac1dA92431EF34C5 "setServiceURI(string)" https://<public orch URI>:<public orch port>
8989
```
9090

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

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

105105
If successful, the output should be:
106106

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

160-
- `-AIServiceRegistry`: Ensures that the Gateway is connected to the Livepeer AI
161-
network.
160+
- `-AIServiceRegistry`: Ensures that the Orchestrator is connected to the Livepeer AI network.
162161
- `-network=arbitrum-one-mainnet`: Connects the AI Orchestrator node to the
163162
Arbitrum Mainnet network.
164163
- `-ethUrl=https://arb1.arbitrum.io/rpc`: Sets the Arbitrum Mainnet RPC URL. You

0 commit comments

Comments
 (0)