Reword Python environment installation guide #152
Conversation
|
Still left TODO: Figure out how to correctly render the lists at the start of the notebook in Also I would like to discuss who is responsible for bootstrapping the requirements (esp. in CI) - do we substitute the install instruction with a |
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #152 +/- ##
=======================================
Coverage 87.66% 87.66%
=======================================
Files 7 7
Lines 446 446
Branches 62 62
=======================================
Hits 391 391
Misses 33 33
Partials 22 22 ☔ View full report in Codecov by Sentry. |
The previous iteration tried to give instructions for a hermetic virtual environment used via ipykernel, but never gave instructions on how to do so. This change removes the recommendation to register the virtual environment as a hermetic kernel, and instead recommends to install all necessary dependencies into the single environment, including Jupyter Notebook itself. Some minor style changes were made to the rest of the setup instructions, including capitalization of Docker everywhere and fixing some incorrect grammar.
…ssifier Also update all filenames and commit messages to reflect the change in tutorial scope. This cuts down docs execution time to under 10 seconds, so it is better for frequent documentation rebuilds while developing. Additionally, we inline the requirements installation into the notebook, since that is the right place for them. The prerequisites part and virtual environment guide is removed, since users are expected to know it.
Happens in the notebook instead.
nicholasjng
force-pushed
the
notebook-install-change
branch
from
35a2b66 to
627c022
Compare
nicholasjng
force-pushed
the
notebook-install-change
branch
from
42522b3 to
326d25a
Compare
|
To finally address @Maciej818's comments (and to see why my responses are correct): The |
|
Restructuring of the put events to be done in a follow-up. |
The previous iteration tried to give instructions for a hermetic virtual environment used via ipykernel, but never gave instructions on how to do so.
This change removes the recommendation to register the virtual environment as a hermetic kernel, and instead recommends to install all necessary dependencies into the single environment, including Jupyter Notebook itself.
Some minor style changes were made to the rest of the setup instructions, including capitalization of Docker everywhere and fixing some incorrect grammar.