-
Notifications
You must be signed in to change notification settings - Fork 13
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
added get-started-experiments generation code #44
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Initial review (mostly just *.md
) for now.
- Since you use
vim
, can you use a plugin which strips trailing spaces (line ending) as well as end-of-file (single-newline)? - Also don't use
[links][like this]
unless you re-use them. Otherwise it's just a liability (broken/missing links) - spotted at least one I think.
May want @dberenbaum's review instead of mine in this one 🙂 Just one minor Q: is "generate.bash" Bash-specific or is it a general Shell script (.sh extension) ? |
Actually I used VS Code with Remote editing in this PR. Vim has these config, I'll take care of this. |
I'm using these because of readability. I read these documents usually as text. They fit into the paragraph and don't distract the flow. Broken links are a different matter, though, I don't put the links while writing and forget to put them sometimes. They are easy to spot though. |
It looks like this PR has already been deployed to https://github.com/iterative/get-started-experiments before being reviewed & merged 🤔 Anyway for all these generation-type stuff we should also have a note at the bottom of generated READMEs linking back to this source repo. |
I generated and pushed the repos because I think it's easier to see the end
product in review.
I see the generation code as an internal stuff while the resulting repos as
the product, but I may add the links to this repo if it feels better.
|
best to push to a temp repo rather than an in-production repo (otherwise defeats at least one of the objectives of review)
exactly. Advanced users (and us too, for our own sanity) care about internal stuff being linked (a one-line contributing section stating "please open PRs in the source repo if you find a bug," etc.) |
Nice @iesahin ! It's way simpler now.
I would keep one nested level (to show that it's possible) Also a few other comments:
|
But overall, I would try at this point to write some documentation first and see what can we get there - then do other iterations on this. |
I think this is done. I'm about to merge if no more changes requested. @shcheklein @jorgeorpinel @casperdcl |
|
||
### Parameters | ||
|
||
There are two parameters in the project. They are set in `params.yaml`. `models.conv_units` defines the number of convolutional units in the model, and `train.epochs` sets the number of epochs to train the model. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
preferable use the same style across all *.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
some minor comments here and there, looks good otherwise to me.
@shcheklein About the root |
…nore should suffice
This PR contains the source code and generation script for https://github.com/iterative/get-started-experiments
generate
scripts for each project #34It includes the general
generate.bash
script that prepares thebuild
directory, calls thegenerate-experiments.bash
and writes a push script that pushes the tags to the repository.generate.bash
andgenerate-experiments.bash
in a single file and move the directory one level upmodels/fashion-mnist/model.h5
to remotedataset-registry
to store models, intermediate artifacts, etc #48prepare
andpreprocess
stages to reduce the intermediate file size and use the cache (Comment in mnist examples: simplify data layout, params, etc #54)fashion-mnist
intermediate directory fromdata
andmodels
to reduce the final depthget-started-experiments
.gitignore
venv
instructions in a<detail>
block