From b001989752df500baea77623a37682e858c8f352 Mon Sep 17 00:00:00 2001 From: Rick Staa Date: Tue, 21 Jan 2025 13:08:16 +0100 Subject: [PATCH] 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. --- ai/gateways/start-gateway.mdx | 4 ++-- ai/orchestrators/ai-worker.mdx | 17 ++++++++--------- ai/orchestrators/onchain.mdx | 11 +++++------ 3 files changed, 15 insertions(+), 17 deletions(-) diff --git a/ai/gateways/start-gateway.mdx b/ai/gateways/start-gateway.mdx index 8babcd92..4cf572af 100644 --- a/ai/gateways/start-gateway.mdx +++ b/ai/gateways/start-gateway.mdx @@ -33,7 +33,7 @@ Follow the steps below to start your Livepeer AI Gateway node: livepeer/go-livepeer:master \ -datadir ~/.lpData2 \ -gateway \ - -orchAddr \ + -orchAddr \ -httpAddr 0.0.0.0:8937 \ -v 6 \ -httpIngest @@ -79,7 +79,7 @@ Follow the steps below to start your Livepeer AI Gateway node: ./livepeer \ -datadir ~/.lpData2 \ -gateway \ - -orchAddr \ + -orchAddr \ -httpAddr 0.0.0.0:8937 \ -v 6 \ -httpIngest diff --git a/ai/orchestrators/ai-worker.mdx b/ai/orchestrators/ai-worker.mdx index 86476829..388b99ee 100644 --- a/ai/orchestrators/ai-worker.mdx +++ b/ai/orchestrators/ai-worker.mdx @@ -56,9 +56,11 @@ 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 + -serviceAddr ``` #### AI Worker Command @@ -66,15 +68,12 @@ docker run \ ```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 \ + -orchAddr ``` diff --git a/ai/orchestrators/onchain.mdx b/ai/orchestrators/onchain.mdx index d70afcfe..823d3eec 100644 --- a/ai/orchestrators/onchain.mdx +++ b/ai/orchestrators/onchain.mdx @@ -41,7 +41,7 @@ Orchestrator node to redeem tickets: ```bash ./livepeer \ - -ethOrchAddr \ + -ethOrchAddr
\ ... \ ``` @@ -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 '' --password '' --rpc-url 0x04C0b249740175999E5BF5c9ac1dA92431EF34C5 "setServiceURI(string)" https://: + cast send --keystore '' --password '' --rpc-url 0x04C0b249740175999E5BF5c9ac1dA92431EF34C5 "setServiceURI(string)" https://: ``` After successful execution, the output should look like this: @@ -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 0x04C0b249740175999E5BF5c9ac1dA92431EF34C5 "getServiceURI(address)" | xxd -r -p + cast call --rpc-url 0x04C0b249740175999E5BF5c9ac1dA92431EF34C5 "getServiceURI(address)" | xxd -r -p ``` If successful, the output should be: ```bash - https://: + https://: ``` @@ -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