Add CLI command to export stack requirements #3158
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
github-actions
bot
added
internal
|
@htahir1 Where? I don't think every random CLI command should have a separate docs page |
|
@schustmi I am not sure how I feel about this myself, but do you think it might be nice to have a |
|
@schustmi It isn't a "random" CLI command (otherwise we wouldn't really need it). It's a CLI command that many of our users want and should be more aware off. I would even say we can upgrade the dashboard to include it instead of the zenml integration install we can ask them to do: 
Just a cursory glance through the docs show me some places:
|
This one I for sure disagree with, |
|
@schustmi yeah, it did not feel right as I was writing that 😄 |
I disagree with both the usefulness and especially the usefullness of a docspage. The dashboard command you linked does not work, because we almost always have other log messages that would mess with the command output, which makes it useless unless writing to a file. |
|
@schustmi cant we make the implementation in a way that we can then pip it to xargs and a pip command? Surely that's the right UX here? even id use it all the time , because I could put it into poetry or uv or conda like that? As for the docs page, it is useless if not treated in the right way, ill leave some suggestions |
| description: Export stack requirements | ||
| --- | ||
|
|
||
| You can get the `pip` requirements of your stack by running the `zenml stack export-requirements <STACK-NAME>` CLI command. |
There was a problem hiding this comment.
This chapter IMO is not about exporting stack requirements. It's about telling a story about:
- Why do we need to install stack requirements locally and in the execution environment?
- What does it mean to export requirements? (i.e. that these requirements are the suggested ranges of values that version of zenml is released with)
- A reason why someone would do this in a production environment
- What is the link between a requirements file generated by this file vs the stack integration installing dependencies that zenml already does when it builds a docker image
| @@ -53,6 +53,8 @@ As you can see a stack can be **active** on your **client**. This simply means t | |||
| {% endtab %} | |||
| {% endtabs %} | |||
|
|
|||
| You can get the `pip` requirements of your stack by running the `zenml stack export-requirements <STACK-NAME>` CLI command. | |||
Describe changes
I implemented/fixed _ to achieve _.
Pre-requisites
Please ensure you have done the following:
developand the open PR is targetingdevelop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.Types of changes