Add -gateway flag, deprecation warning for -broadcaster #3048
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eliteprox
changed the title
rickstaa
force-pushed
the
add-gateway-flag
branch
from
6822dc5
to
0cfe756
Compare
|
@eliteprox great! Merged into the upstream 🚀. |
|
@hthillman We've decided to deprecate the |
rickstaa
pushed a commit
to livepeer/docs
that referenced
this pull request
May 13, 2024
…ion (#564) This commit replaces the `broadcaster` flag with the new `gateway` flag. See livepeer/go-livepeer#3048 for more information.
This was referenced May 15, 2024
Merged
rickstaa
added a commit
to livepeer/docs
that referenced
this pull request
May 21, 2024
* 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. * docs(ai): improve subsection titles and discovery text This commit improves the subsection titles and Discovery text. * docs(ai): improve introduction text * ci(ai): add AI pipelines document structure * 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. * 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. * chore(ai): cleanup redundant OpenAPI entries * ci(ai): add AI docs codeowners * docs(ai): add pipelines documentation This commit adds the initial draft for the documentation that explains the pipelines available on the network. * docs(ai): fix broken images This commit ensures that images are working when deployed on the remote. * 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. * 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. * 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. * Livepeer.Cloud SPE Milestone #1 Deliverables: Add Gateway Docs * docs(ai): improve AI subnet introduction This commit improves the AI subnet introduction page. * fix(ai): fix kickstart collab card link This commit ensures that the collaboration card is linked correctly. * refactor(ai): improve pipeline mermaid diagrams This commit improves the styling used in the pipeline mermaid diagrams. * refactor(ai): improve pipeline documentation This commit updates the pipelines documentation to increase readability. * 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). * feat(ai): add builders page This commit adds the builders page and a showcase to show dApps already build on the AI subnet. * 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. * feat(ai): add orchestrator setup guide This commit adds the orchestrator setup guide. * refactor(ai): improve showcase descriptions This commit improves the descriptions of the projects in the showcase. * refactor(ai): highlight showcase keywords This commit highlights some keywords in the showcase descriptions. * 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. * 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". * fix(ai): fix broken AI gateway links This commit fixes several broken internal links in the AI gateway docs. * refactor(ai): improve AI subnet introduction section This commit improves the readability of the AI subnet introduction section. * refactor(ai): hide contribution/SDK pages and cleanup pipelines This commit hides the contribution and SDK pages and cleansup the pipeline pages. * refactor(ai): improve text formatting This commit applies some last text formatting improvements. * addressed review comments from Rick * 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. * chore(ai): fix small typo This commit fixes some small typos. * refactor(ai): fix spelling This commit fixes some small spelling errors. * made Prerequisites - more concise * chore(ai): add Analytics token This commit adds the Google Analytics GA4 token to the documentation config. * 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). * refactor(ai): gateway former naming comment This commit makes it more clear that Gateways were formaly named Broadcasters. * 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. * 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> * 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. * docs(ai): fix incorrect RealViLightning model link This commit ensures that the RealVizLightning model link is pointing to the right url. * 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. * docs: replace -broadcaster flag with -gateway in AI subnet documentation (#564) This commit replaces the `broadcaster` flag with the new `gateway` flag. See livepeer/go-livepeer#3048 for more information. * 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. * 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. * docs: add Gateway network page This commit adds a Gateway page under the core-concepts category, explaining the role and functions of a Gateway. * docs: improve Gateway configuration wording * chore: apply prettier to Gateway node page * Update gateways.mdx Clarified gateways as the type of node, and talked about hosted gateways as something that individual entities may run. * docs: fix Gateway node page links This commit fixes some broken links in the Gateway node page. * docs(ai): remove double subnet requirements text This commit removes duplicate text in the AI subnet requirements section. * docs(ai): address community feedback This commit clarifies points that the community identified as unclear. * docs(ai): enhance introduction This commit strengthens the AI Subnet introduction, providing clearer and more detailed information about its capabilities and benefits. * 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%. * 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. * docs(ai): ensure GPU binaries are listed This commit ensures the GPU binaries are listed in the Orchestrator binary setup guide. * docs(ai): fix incorrect binary format This commit fixes a small syntax error in the AI subnet GPU binary download url. * 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. * docs(ai): improve introduction This commit improves the introduction to make clear that orchestrators can have multiple workers. It also improves the diagram. * docs(ai): change dApp to app This commit ensures that all references to dApp are replaced by app or application. * docs(ai): apply some small text improvements This commit applies some small text improvements to the AI documentation. * docs(ai): update AI API reference This commit updates the AI API reference to include the new `nsfw` feature (see livepeer/ai-worker@272ac74). * refactor(ai) improve introduction wording (#570) * Update verbiage in introduction * docs(ai): mention AI Video subnet --------- Co-authored-by: Elite Encoder <john@eliteencoder.net> --------- Co-authored-by: Mike Zupper <me@mikezupper.com> Co-authored-by: Authority_Null <95463891+AuthorityNull@users.noreply.github.com> Co-authored-by: Chuck Chain <36555842+ChuckChain@users.noreply.github.com> Co-authored-by: Elite Encoder <john@eliteencoder.net> Co-authored-by: Mike Zupper <70441620+mikezupper@users.noreply.github.com> Co-authored-by: Doug Petkanics <petkanics@gmail.com>
5 tasks
This was referenced Jul 1, 2024
Merged
This was referenced Jul 14, 2024
eliteprox
added a commit
to eliteprox/go-livepeer
that referenced
this pull request
Jul 26, 2024
This commit adds the `gateway` flag and deprecates the `broadcaster` flag per core team decision (details: https://discord.com/channels/423160867534929930/1051963444598943784/1210356864643109004).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this pull request do? Explain your changes. (required)
Adds the new -gateway flag while maintaining support for
-broadcasterwith a deprecation warning on startup. This change does not address refactoring associated with variable names and types, which will be addressed in a later change.Specific updates (required)
-gatewayflagHow did you test each of these updates (required)
-gatewayflag-broadcasterflag, noted deprecation warningDoes this pull request close any open issues?
LIV-287 Allow users to use -gateway instead of -broadcaster
Checklist:
makeruns successfully./test.shpass