paris-saclay-cds / ramp-workflow

Toolkit for building predictive workflows on top of pydata (pandas, scikit-learn, pytorch, keras, etc.).
https://paris-saclay-cds.github.io/ramp-docs/
BSD 3-Clause "New" or "Revised" License
68 stars 43 forks source link

DOC Update prepare_data instructions #235

Closed lucyleeow closed 4 years ago

lucyleeow commented 4 years ago

Update documentation to instruct that prepare_data.py does not copy the public data files to the 'ramp-kits' directory. This should be done on the server to be robust to different server file configurations.

Made some clarifications as well.

cc @glemaitre @agramfort

codecov[bot] commented 4 years ago

Codecov Report

Merging #235 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #235   +/-   ##
=======================================
  Coverage   81.70%   81.70%           
=======================================
  Files         133      133           
  Lines        4909     4909           
=======================================
  Hits         4011     4011           
  Misses        898      898           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 2d999ce...72c78d6. Read the comment docs.

agramfort commented 4 years ago

@maikia merge if you're happy

lucyleeow commented 4 years ago

Actually one thing I am not clear about is whether the prepare_data.py is strictly required for deploying on the server. I'll wait to see what @glemaitre says (sorry, thank you)

lucyleeow commented 4 years ago

Okay this is good to go @maikia (thanks for clarifying @glemaitre).

lucyleeow commented 4 years ago

thanks for the reviews!