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

docs(ai): add ai-subnet documentation #549

Merged
merged 77 commits into from May 21, 2024
Merged

docs(ai): add ai-subnet documentation #549

merged 77 commits into from May 21, 2024

Conversation

rickstaa
Copy link
Contributor

@rickstaa rickstaa commented Apr 18, 2024

This pull request contains the initial documentation for the AI subnet.

This commit adds documentation on how Orchestrators can broadcast
their AI subnet service URIs to AI subnet Gateways, enabling their
discovery on the subnet for job execution.
This commit improves the subsection titles and Discovery text.
This commit adds a guide on how AI nodes can advertise their AI URI
using the Arbitrum explorer.
This commit adds an initial draft for the AI Subnet API reference. It is
not yet linked to an upstream API endpoint so the playground is not yet
working.
@rickstaa rickstaa marked this pull request as ready for review April 19, 2024 11:41
@rickstaa rickstaa marked this pull request as draft April 19, 2024 11:41
rickstaa and others added 12 commits April 19, 2024 18:48
This commit adds the initial draft for the documentation that explains
the pipelines available on the network.
This commit ensures that images are working when deployed on the remote.
This commit replaces the relative image paths used in the pipelines
documentation with external paths. We can change this back if we found a
way to use relative paths inside mermaid graphs.
This commit adds a general scaffold for the contribution pages. It is a
quick draft and should not yet be published to the upstream docs.
This commit adds a general scaffold for the contribution pages. It is a
quick draft and should not yet be published to the upstream docs.
This commit improves the AI subnet introduction page.
This commit ensures that the collaboration card is linked correctly.
This commit improves the styling used in the pipeline mermaid
diagrams.
This commit updates the pipelines documentation to increase
readability.
This commit implements a temporary solution to address the issue of
images not displaying correctly when embedded in a mermaid graph on the
deployed site. Can be replaced with relative path if mintlify fixes the
issue (see
https://mintlify-users.slack.com/archives/C05D00NS55F/p1714485030542069).
mikezupper and others added 16 commits May 16, 2024 07:32
docs(gateway): apply prettier mdx formatting
This commit adds a Gateway page under the core-concepts category, explaining the
role and functions of a Gateway.
…y_network_participant_page

docs: add Gateway network page
Clarified gateways as the type of node, and talked about hosted gateways as something that individual entities may run.
This commit fixes some broken links in the Gateway node page.
This commit removes duplicate text in the AI subnet requirements
section.
This commit clarifies points that the community identified as unclear.
This commit strengthens the AI Subnet introduction, providing clearer
and more detailed information about its capabilities and benefits.
This commit adds the DeepCache optimization method to the AI models
configuration page. This method can be used to speedup the pipelines to
up to 50%.
rickstaa and others added 10 commits May 19, 2024 16:04
This commit replaces the parts that mention dApps with applications
since the AI subnet can serve both web2 and web3 applications.
This commit ensures the GPU binaries are listed in the Orchestrator
binary setup guide.
This commit fixes a small syntax error in the AI subnet GPU binary
download url.
This commit ensures that people are aware that they only need to create
a HuggingFace token with read permissions.
This commit improves the introduction to make clear that orchestrators
can have multiple workers. It also improves the diagram.
This commit ensures that all references to dApp are replaced by app or
application.
This commit applies some small text improvements to the AI
documentation.
This commit updates the AI API reference to include the new `nsfw`
feature (see
livepeer/ai-worker@272ac74).
* Update verbiage in introduction

* docs(ai): mention AI Video subnet

---------

Co-authored-by: Elite Encoder <john@eliteencoder.net>
Copy link
Member

@dob dob left a comment

Choose a reason for hiding this comment

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

Approved based on staged deploy to unblock docs for launch.

@rickstaa rickstaa merged commit 61d59fc into main May 21, 2024
1 check passed
@rickstaa rickstaa deleted the ai-video branch May 21, 2024 01:30
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.

None yet

4 participants