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

Local development how-to section #3090

Merged
merged 13 commits into from
Oct 17, 2024
Merged

Local development how-to section #3090

merged 13 commits into from
Oct 17, 2024

Conversation

strickvl
Copy link
Contributor

@strickvl strickvl commented Oct 16, 2024

added two docs pages

  • use of config files to support local / remote development switching
  • 'clean' pipelines / unlisted runs etc

Also renamed a file from #3084 that I'd forgotten to rename before merging.

@strickvl strickvl added documentation Improvements or additions to documentation internal To filter out internal PRs and issues labels Oct 16, 2024
@strickvl strickvl requested review from htahir1 and wjayesh October 16, 2024 12:14
Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

good direction! One big review point i would add to the rest of my review is that we need some docs on working on a notebook

@@ -0,0 +1,89 @@
---
description: Learn how to use configuration files to manage local development.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the moment i hear this, i think "oh its slow" . maybe the intent of the chapter is rather that you want to set up different "modes" of your pipeline that load smaller data in a local case? And config files are sort of one way to do that but you can also do it in code right?

Copy link
Contributor

Choose a reason for hiding this comment

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

So reframe it to talk more about having different "variants" of your pipeline in dev, and production.. maybe some if conditions that loads a different dataset or something?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@strickvl
Copy link
Contributor Author

@htahir1 I originally had a section on notebooks, but then it seemed too similar to all of this: https://docs.zenml.io/how-to/run-remote-steps-and-pipelines-from-notebooks. I'll think about it another time while updating on the basis of these comments

@strickvl strickvl requested review from wjayesh and htahir1 October 17, 2024 08:45
Copy link
Contributor

@htahir1 htahir1 left a comment

Choose a reason for hiding this comment

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

Great one! Almost there

@strickvl strickvl requested a review from htahir1 October 17, 2024 10:28
@strickvl strickvl merged commit 4f22b60 into develop Oct 17, 2024
9 checks passed
@strickvl strickvl deleted the doc/local-development branch October 17, 2024 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants