1 add existing demos - Githubissues

thomose commented 2 years ago

Closes #1

thomose commented 2 years ago

Note: @brob00 is providing an external review

brob00 commented 2 years ago

[x] repo could be renamed to something else than tutorials to avoid confusion
[x] /tutorials/README.md: How can an account be obtained? (can an admin be asked to provide credentials?)
[x] /tutorials/README.md: remove everything from the prerequisite section that the user will be guided through in the later sections anyways (so note1 is redundant)
[x] change paths in tutorials/demos/wine-quality-estimator/mlproject/recipe.def so that the apptainer/singularity build command can be executed while being in the wine-quality-estimator directory (otherwise, there will be a file-not-found error)
[x] in demo/wine-quality-estimator/README.md
- [x] explain that there already exists a backend-config file in the mlproject subdirectory (right now, it is unclear to me whether you have to generate your own one based on the sample code in the README)
- [x] add right after the backend config section a single line that demo can be executed by running (poetry run) python run.py (I went back to the top-level README thinking the demo is over)
[x] when executing the demo locally, logging does not seem to work correctly
[x] for first time users: when a new account was provided by an admin, one first needs to got to https://test.cloud.mantik.ai/ and change the password and thereafter set the PASSWORD env variable in the terminal. A short remark in the READMEs could prevent confusion
[x] when I tried to log in and set a new password at https://test.cloud.mantik.ai/ an error occurred, should be looked into
[x] in general, it would be nice to have some notes on when you should expect a change in the cloud.mantik.ai UI so one can be sure that everything worked the way it is supposed to (e.g. Now you should see a new run in the corresponding experiment directory. It might take some time until everything is logged correctly.)

I did not yet take a look at the user guide!

brob00 commented 2 years ago

[x] tutorials/README.md: typo in Usage: Tracking second line "work" instead of work
[x] tutorials/README.md: Last paragraph on the bottom should not be code

mantik-ai / tutorials

1 add existing demos #2