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

Commits on Apr 18, 2024

  1. docs(ai): add on-chain discovery documentation

    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.
    rickstaa committed Apr 18, 2024
    Configuration menu
    Copy the full SHA
    5ea3a59 View commit details
    Browse the repository at this point in the history
  2. docs(ai): improve subsection titles and discovery text

    This commit improves the subsection titles and Discovery text.
    rickstaa committed Apr 18, 2024
    Configuration menu
    Copy the full SHA
    d685ecd View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    2b2f204 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    7b1d280 View commit details
    Browse the repository at this point in the history

Commits on Apr 19, 2024

  1. docs(ai): add artibtrum explorer discovery steps

    This commit adds a guide on how AI nodes can advertise their AI URI
    using the Arbitrum explorer.
    rickstaa committed Apr 19, 2024
    Configuration menu
    Copy the full SHA
    ee4d37f View commit details
    Browse the repository at this point in the history
  2. docs(ai): add AI API reference

    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 committed Apr 19, 2024
    Configuration menu
    Copy the full SHA
    8eba5f0 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    428a92e View commit details
    Browse the repository at this point in the history

Commits on Apr 21, 2024

  1. Configuration menu
    Copy the full SHA
    9b03631 View commit details
    Browse the repository at this point in the history

Commits on Apr 25, 2024

  1. docs(ai): add pipelines documentation

    This commit adds the initial draft for the documentation that explains
    the pipelines available on the network.
    rickstaa committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    6b88093 View commit details
    Browse the repository at this point in the history
  2. docs(ai): fix broken images

    This commit ensures that images are working when deployed on the remote.
    rickstaa committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    0cdda07 View commit details
    Browse the repository at this point in the history
  3. feat(ai): temporarily use external paths for pipeline images

    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.
    rickstaa committed Apr 25, 2024
    Configuration menu
    Copy the full SHA
    c04efec View commit details
    Browse the repository at this point in the history

Commits on Apr 26, 2024

  1. feat(ai): add contribution pages scaffold

    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.
    rickstaa committed Apr 26, 2024
    Configuration menu
    Copy the full SHA
    56cfebb View commit details
    Browse the repository at this point in the history
  2. feat(ai): add contribution pages scaffold (#553)

    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.
    rickstaa committed Apr 26, 2024
    Configuration menu
    Copy the full SHA
    4e341d6 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    de30783 View commit details
    Browse the repository at this point in the history

Commits on Apr 30, 2024

  1. docs(ai): improve AI subnet introduction

    This commit improves the AI subnet introduction page.
    rickstaa committed Apr 30, 2024
    Configuration menu
    Copy the full SHA
    4e03074 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    074dc52 View commit details
    Browse the repository at this point in the history
  3. fix(ai): fix kickstart collab card link

    This commit ensures that the collaboration card is linked correctly.
    rickstaa committed Apr 30, 2024
    Configuration menu
    Copy the full SHA
    a00dabb View commit details
    Browse the repository at this point in the history
  4. refactor(ai): improve pipeline mermaid diagrams

    This commit improves the styling used in the pipeline mermaid
    diagrams.
    rickstaa committed Apr 30, 2024
    Configuration menu
    Copy the full SHA
    b60a811 View commit details
    Browse the repository at this point in the history
  5. refactor(ai): improve pipeline documentation

    This commit updates the pipelines documentation to increase
    readability.
    rickstaa committed Apr 30, 2024
    Configuration menu
    Copy the full SHA
    283cd00 View commit details
    Browse the repository at this point in the history
  6. fix(ai): implement temporary solution for mermaid image issue

    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).
    rickstaa committed Apr 30, 2024
    Configuration menu
    Copy the full SHA
    8fb2b86 View commit details
    Browse the repository at this point in the history

Commits on May 1, 2024

  1. feat(ai): add builders page

    This commit adds the builders page and a showcase to show dApps already
    build on the AI subnet.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    632db94 View commit details
    Browse the repository at this point in the history
  2. refactor(ai): add cloud API disclaimer

    This commit adds a small disclaimer to the API documentation that states
    that the livepeer.cloud API is not production ready.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    b8f15a9 View commit details
    Browse the repository at this point in the history
  3. feat(ai): add orchestrator setup guide

    This commit adds the orchestrator setup guide.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    95fa5c0 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    c0e121b View commit details
    Browse the repository at this point in the history
  5. refactor(ai): improve showcase descriptions

    This commit improves the descriptions of the projects in the showcase.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    8563d95 View commit details
    Browse the repository at this point in the history
  6. refactor(ai): highlight showcase keywords

    This commit highlights some keywords in the showcase descriptions.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    79fe635 View commit details
    Browse the repository at this point in the history
  7. feat(ai): add AI gateway docs

    This commit adds the documentation for setting up a AI gateway on the AI
    subnet. It also improves the project structure.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    a9d9ad3 View commit details
    Browse the repository at this point in the history
  8. refactor(ai): adopt impersonal writing style (#556)

    This commit updates the text to reflect an impersonal writing style,
    consistent with the ecosystem's voice. It eliminates personal pronouns
    such as "our" and "we".
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    0ba3b91 View commit details
    Browse the repository at this point in the history
  9. Configuration menu
    Copy the full SHA
    25530e0 View commit details
    Browse the repository at this point in the history
  10. fix(ai): fix broken AI gateway links

    This commit fixes several broken internal links in the AI gateway docs.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    59b4db9 View commit details
    Browse the repository at this point in the history
  11. refactor(ai): improve AI subnet introduction section

    This commit improves the readability of the AI subnet introduction
    section.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    7c66d4a View commit details
    Browse the repository at this point in the history
  12. refactor(ai): hide contribution/SDK pages and cleanup pipelines

    This commit hides the contribution and SDK pages and cleansup the
    pipeline pages.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    9197ab7 View commit details
    Browse the repository at this point in the history
  13. refactor(ai): improve text formatting

    This commit applies some last text formatting improvements.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    46f4865 View commit details
    Browse the repository at this point in the history
  14. Configuration menu
    Copy the full SHA
    c27c7d9 View commit details
    Browse the repository at this point in the history
  15. refactor(ai): add model parameter callout to API docs

    This commit adds a model parameter callout to the API docs to explain
    that not all parameters are used by all models.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    05871be View commit details
    Browse the repository at this point in the history
  16. chore(ai): fix small typo

    This commit fixes some small typos.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    0f58773 View commit details
    Browse the repository at this point in the history
  17. refactor(ai): fix spelling

    This commit fixes some small spelling errors.
    rickstaa committed May 1, 2024
    Configuration menu
    Copy the full SHA
    e504e64 View commit details
    Browse the repository at this point in the history
  18. Configuration menu
    Copy the full SHA
    ec47a72 View commit details
    Browse the repository at this point in the history

Commits on May 2, 2024

  1. Configuration menu
    Copy the full SHA
    d1fd937 View commit details
    Browse the repository at this point in the history
  2. chore(ai): add Analytics token

    This commit adds the Google Analytics GA4 token to the documentation
    config.
    rickstaa committed May 2, 2024
    Configuration menu
    Copy the full SHA
    4e7999f View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    d78d712 View commit details
    Browse the repository at this point in the history
  4. docs(gateway): apply prettier mdx formatting

    This commit applies the prettier formatting suggestions on the Gateway
    docs (see https://prettier.io/blog/2021/11/25/2.5.0.html).
    rickstaa committed May 2, 2024
    Configuration menu
    Copy the full SHA
    38b420c View commit details
    Browse the repository at this point in the history

Commits on May 3, 2024

  1. refactor(ai): gateway former naming comment

    This commit makes it more clear that Gateways were formaly named
    Broadcasters.
    rickstaa committed May 3, 2024
    Configuration menu
    Copy the full SHA
    108a7e5 View commit details
    Browse the repository at this point in the history

Commits on May 4, 2024

  1. refactor(ai): simplify binary install

    This commit simplifies the binary install of the AI subnet by giving
    users one simple download url they can use to downloade the latest
    `ai-video` branch binary. This was made possible in
    livepeer/go-livepeer@fb9764b.
    rickstaa committed May 4, 2024
    Configuration menu
    Copy the full SHA
    dd8e816 View commit details
    Browse the repository at this point in the history
  2. docs(ai): apply community feedback

    This commit applies the feedback I received from the community about
    things that could be improved.
    
    Co-authored-by: Authority_Null <95463891+AuthorityNull@users.noreply.github.com>
    Co-authored-by: Chuck Chain <36555842+ChuckChain@users.noreply.github.com>
    3 people committed May 4, 2024
    Configuration menu
    Copy the full SHA
    ef79565 View commit details
    Browse the repository at this point in the history

Commits on May 5, 2024

  1. docs(ai): add RealViz warm comment

    This commit adds a comment letting users know that several orchestrators
    have the https://huggingface.co/SG161222/RealVisXL_V4.0 model warm on
    their GPU.
    rickstaa committed May 5, 2024
    Configuration menu
    Copy the full SHA
    b6606e1 View commit details
    Browse the repository at this point in the history

Commits on May 13, 2024

  1. docs(ai): fix incorrect RealViLightning model link

    This commit ensures that the RealVizLightning model link is pointing to the
    right url.
    rickstaa committed May 13, 2024
    Configuration menu
    Copy the full SHA
    8bc7f00 View commit details
    Browse the repository at this point in the history
  2. chore(ai): update AI subnet OpenAPI spec

    This commit updates the AI subnet OpenApi spec so that the reference
    documentation correctly represents the new `num_inference_steps`
    parameter introduced in livepeer/ai-worker#80.
    rickstaa committed May 13, 2024
    Configuration menu
    Copy the full SHA
    c652980 View commit details
    Browse the repository at this point in the history
  3. docs: replace -broadcaster flag with -gateway in AI subnet documentat…

    …ion (#564)
    
    This commit replaces the `broadcaster` flag with the new `gateway` flag. See livepeer/go-livepeer#3048 for more information.
    eliteprox committed May 13, 2024
    Configuration menu
    Copy the full SHA
    416abd3 View commit details
    Browse the repository at this point in the history

Commits on May 14, 2024

  1. docs(ai): remove pricePerUnit requirement for AI docs (#565)

    This commit removes the dependency on the `pricePerUnit` flag in the AI orchestrator documentation now that livepeer/go-livepeer#3047 has been merged.
    eliteprox committed May 14, 2024
    Configuration menu
    Copy the full SHA
    3916033 View commit details
    Browse the repository at this point in the history

Commits on May 15, 2024

  1. docs(ai): add RealVisXL to I2I pipeline

    This commit adds the
    [SG161222/RealVisXL_V4.0_Lightning](https://huggingface.co/SG161222/RealVisXL_V4.0_Lightning)
    model to the supported models on the I2I pipeline documentation page.
    rickstaa committed May 15, 2024
    Configuration menu
    Copy the full SHA
    c67331e View commit details
    Browse the repository at this point in the history

Commits on May 16, 2024

  1. Merge pull request #3 from livepeer/task/papa/add_gateway_prettier

    docs(gateway): apply prettier mdx formatting
    mikezupper committed May 16, 2024
    Configuration menu
    Copy the full SHA
    8c68293 View commit details
    Browse the repository at this point in the history
  2. docs: add Gateway network page

    This commit adds a Gateway page under the core-concepts category, explaining the
    role and functions of a Gateway.
    rickstaa committed May 16, 2024
    Configuration menu
    Copy the full SHA
    1a10885 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    9e8f717 View commit details
    Browse the repository at this point in the history
  4. Merge pull request #4 from livepeer/tasks/papa/add_gateway_add_gatewa…

    …y_network_participant_page
    
    docs: add Gateway network page
    mikezupper committed May 16, 2024
    Configuration menu
    Copy the full SHA
    b9b57e9 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    879530e View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    8a380e1 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    7887cff View commit details
    Browse the repository at this point in the history
  8. Update gateways.mdx

    Clarified gateways as the type of node, and talked about hosted gateways as something that individual entities may run.
    dob committed May 16, 2024
    Configuration menu
    Copy the full SHA
    d535cad View commit details
    Browse the repository at this point in the history
  9. Configuration menu
    Copy the full SHA
    f55e514 View commit details
    Browse the repository at this point in the history
  10. docs: fix Gateway node page links

    This commit fixes some broken links in the Gateway node page.
    rickstaa committed May 16, 2024
    Configuration menu
    Copy the full SHA
    3878ada View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    467744c View commit details
    Browse the repository at this point in the history
  12. Configuration menu
    Copy the full SHA
    b203eb8 View commit details
    Browse the repository at this point in the history

Commits on May 17, 2024

  1. docs(ai): remove double subnet requirements text

    This commit removes duplicate text in the AI subnet requirements
    section.
    rickstaa committed May 17, 2024
    Configuration menu
    Copy the full SHA
    f3851af View commit details
    Browse the repository at this point in the history
  2. docs(ai): address community feedback

    This commit clarifies points that the community identified as unclear.
    rickstaa committed May 17, 2024
    Configuration menu
    Copy the full SHA
    2359bed View commit details
    Browse the repository at this point in the history
  3. docs(ai): enhance introduction

    This commit strengthens the AI Subnet introduction, providing clearer
    and more detailed information about its capabilities and benefits.
    rickstaa committed May 17, 2024
    Configuration menu
    Copy the full SHA
    c12a79e View commit details
    Browse the repository at this point in the history
  4. docs(ai): add DeepCache optimization method

    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 committed May 17, 2024
    Configuration menu
    Copy the full SHA
    7755f69 View commit details
    Browse the repository at this point in the history

Commits on May 19, 2024

  1. docs(ai): replace dApp with application

    This commit replaces the parts that mention dApps with applications
    since the AI subnet can serve both web2 and web3 applications.
    rickstaa committed May 19, 2024
    Configuration menu
    Copy the full SHA
    833caae View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    1c37adb View commit details
    Browse the repository at this point in the history

Commits on May 20, 2024

  1. docs(ai): ensure GPU binaries are listed

    This commit ensures the GPU binaries are listed in the Orchestrator
    binary setup guide.
    rickstaa committed May 20, 2024
    Configuration menu
    Copy the full SHA
    b7bacee View commit details
    Browse the repository at this point in the history
  2. docs(ai): fix incorrect binary format

    This commit fixes a small syntax error in the AI subnet GPU binary
    download url.
    rickstaa committed May 20, 2024
    Configuration menu
    Copy the full SHA
    c8069e2 View commit details
    Browse the repository at this point in the history
  3. docs(ai): add HuggingFace token read permission comment

    This commit ensures that people are aware that they only need to create
    a HuggingFace token with read permissions.
    rickstaa committed May 20, 2024
    Configuration menu
    Copy the full SHA
    9e0761d View commit details
    Browse the repository at this point in the history
  4. docs(ai): improve introduction

    This commit improves the introduction to make clear that orchestrators
    can have multiple workers. It also improves the diagram.
    rickstaa committed May 20, 2024
    Configuration menu
    Copy the full SHA
    9785dcc View commit details
    Browse the repository at this point in the history
  5. docs(ai): change dApp to app

    This commit ensures that all references to dApp are replaced by app or
    application.
    rickstaa committed May 20, 2024
    Configuration menu
    Copy the full SHA
    0bc2c0e View commit details
    Browse the repository at this point in the history
  6. docs(ai): apply some small text improvements

    This commit applies some small text improvements to the AI
    documentation.
    rickstaa committed May 20, 2024
    Configuration menu
    Copy the full SHA
    ce3c882 View commit details
    Browse the repository at this point in the history
  7. docs(ai): update AI API reference

    This commit updates the AI API reference to include the new `nsfw`
    feature (see
    livepeer/ai-worker@272ac74).
    rickstaa committed May 20, 2024
    Configuration menu
    Copy the full SHA
    5a96ebe View commit details
    Browse the repository at this point in the history
  8. refactor(ai) improve introduction wording (#570)

    * Update verbiage in introduction
    
    * docs(ai): mention AI Video subnet
    
    ---------
    
    Co-authored-by: Elite Encoder <john@eliteencoder.net>
    rickstaa and eliteprox committed May 20, 2024
    Configuration menu
    Copy the full SHA
    32774e2 View commit details
    Browse the repository at this point in the history