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.

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

Add ai subnet orch docs #2982

Merged
merged 19 commits into from
Apr 8, 2024
Merged

Add ai subnet orch docs #2982

merged 19 commits into from
Apr 8, 2024

Conversation

rickstaa
Copy link
Member

@rickstaa rickstaa commented Mar 25, 2024

What does this pull request do? Explain your changes. (required)

This commit adds detailed instructions for setting up an orchestrator on the AI Subnet.

Specific updates (required)

How did you test each of these updates (required)

Does this pull request close any open issues?

Checklist:

@rickstaa rickstaa marked this pull request as draft March 25, 2024 16:15
@rickstaa
Copy link
Member Author

rickstaa commented Mar 25, 2024

@yondonfu, to ensure the Docker container operates successfully, please rebase your branch onto the master branch. Once completed, I'll rebase my branch onto yours again. I've marked this as a draft as I still need to add additional information for putting it on-chain, such as recipientAddr. I'll include this later once my Orchestrator is on-chain. Additionally, to minimize code changes in the docker run command, I've now utilized the --network host flag. However, please note that this may introduce security risks which will need to be addressed later.

@rickstaa rickstaa marked this pull request as ready for review March 25, 2024 17:17
@rickstaa rickstaa mentioned this pull request Mar 25, 2024
5 tasks
@rickstaa rickstaa force-pushed the add_ai_subnet_orch_docs branch from 56d4439 to 101b3bb Compare March 25, 2024 17:24
@yondonfu
Copy link
Member

please rebase your branch onto the master branch.

This is done.

@rickstaa rickstaa force-pushed the add_ai_subnet_orch_docs branch from 101b3bb to 2654ed7 Compare March 25, 2024 17:46
This commit adds detailed instructions for setting up an
orchestrator on the AI Subnet.
This commit adds detailed instructions for setting up an
broadcaster on the AI Subnet.
@rickstaa rickstaa force-pushed the add_ai_subnet_orch_docs branch from 2654ed7 to b3fdf31 Compare March 25, 2024 17:48
@rickstaa
Copy link
Member Author

Now that the CI build the container I will update the documentation. I will also try to include a section that explains how to use the pre-build binaries 👍🏻.

This commit refines the AI Subnet documentation and introduces instructions for
utilizing the prebuilt AI Subnet binaries.
@rickstaa rickstaa marked this pull request as draft March 25, 2024 20:15
rickstaa and others added 12 commits March 27, 2024 12:51
This commit improves the AI subnet documentation by adding some missing
steps and improved unclear steps. Special thanks to @Pon-node for
walking through the documentation as I could code along and improve it.

Co-authored-by: Pon <94224680+Pon-node@users.noreply.github.com>
This commit fixes a broken huggingface documentation link.

Co-authored-by: papabear99 <89408276+papabear99@users.noreply.github.com>
This commit fixes the broken `dl_checkpoints.sh` run command found in
the documentation.

Co-authored-by: papabear99 <89408276+papabear99@users.noreply.github.com>
This commit refines the AI subnet documentation to address ambiguities
and inaccuracies identified during our initial pilot with **pre-alpha**
participants. The improvements aim to provide clearer instructions and
correct information for a smoother user experience.
This commit explaines the parameters found in the `aiModels.json` file.
…chestrator

This commit introduces comprehensive instructions for setting up the AI
Subnet Orchestrator for on-chain operation. It includes both binary and
Docker setup methods.
This commit restructures the AI on-chain instructions to make them
easier to follow.
This commit applies some small syntax changes to the ai documentation to
improve readability.
This commit adds some documentation on how people can **opt-in** to send
us data about their AI Subnet Orchestrator.
This update modifies the volume mount for the promptail docker container
to remove the ai_subnet_promtail.yml file, addressing issues reported by
several users with the previous promtail docker configuration.
This commit ensures that people use named docker containers. This will
help us monitor their metrics when they decide to share them.
@rickstaa rickstaa force-pushed the add_ai_subnet_orch_docs branch from a4ce20c to 5e26f41 Compare March 29, 2024 20:32
@rickstaa
Copy link
Member Author

rickstaa commented Apr 4, 2024

@rickstaa rickstaa closed this Apr 4, 2024
@rickstaa rickstaa reopened this Apr 5, 2024
rickstaa added 3 commits April 5, 2024 15:10
This commit improves the description of the `warm` configuration value
and add the `ticketEV` flag to the Livepeer command line arguments to
prevent the `too many values` error from occuring. This error is thrown
because the current software does not allow sending more than 150
tickets in one batch.
This commit ensures it is clear that the redeemer is not recommended
when setting up a AI subnet orchestrator. It also explains that the
`pricePerUnit` flag is not needed for the AI subnet orchestrator.
@rickstaa rickstaa force-pushed the add_ai_subnet_orch_docs branch from 10ec559 to aa706dc Compare April 5, 2024 19:55
This commit ensures that users know which output to expect when they run
the commands in the documentation:
1. Create a new Ethereum account for your _Mainnet AI Subnet_ Orchestrator. It is recommended that you use a separate account from your _Mainnet Transcoding Network_ Orchestrator for security reasons.
2. Fund the Ethereum account with enough ETH to cover the gas costs of redeeming the AI tickets **on-chain**.
3. Open port `8936` on your machine and set up port forwarding on your router to make the _Mainnet AI Subnet_ Orchestrator accessible from the internet.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Orchestrator running in WSL: If you cannot access your orchestrator in port 8936 even after forwarding port in router and setting up firewall, use the Netsh interface portproxy guide from Accessing a WSL 2 distribution from your local area network (LAN).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JJassonn69 thanks for the update. I will implement your changes in a subsequent pull request.

@rickstaa rickstaa marked this pull request as ready for review April 8, 2024 11:01
@rickstaa rickstaa merged commit 9db7a1b into ai-video Apr 8, 2024
7 of 9 checks passed
@rickstaa rickstaa deleted the add_ai_subnet_orch_docs branch April 8, 2024 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants