Skip to content

Latest commit

 

History

History
75 lines (48 loc) · 2.65 KB

README.md

File metadata and controls

75 lines (48 loc) · 2.65 KB

Time for Crab 🦀

Crabs are here, and they're mighty tasty.

Knowing how old they are helps identify full-sized crabs that are ready for the pot.

Prediction (regression) of mud crab age based on physical features.

YouTube Playlist

Time for Crab

Table of Contents

Notebook Viewer

If you're having trouble viewing the notebooks in GitHub, try using nbviewer.

https://nbviewer.org/github/ahester57/ai_workshop/blob/master/notebooks/time_for_crab/0-eda/eda.ipynb

Also on Overleaf 🍃

The project is also available on Overleaf, a LaTeX editor. This is useful for writing reports and papers, but this repository remains the source of truth for this project.

Export a Notebook

You will need to install the optional jupyter dependencies to export the notebooks.

From the project root, run:

pip install -e .[jupyter]

Export to HTML

To export the notebooks to HTML, use the following commands:

jupyter nbconvert --to html --embed-images notebooks/time_for_crab/0-eda/eda.ipynb
jupyter nbconvert --to html --embed-images notebooks/time_for_crab/0-eda/overfit.ipynb
jupyter nbconvert --to html --embed-images notebooks/time_for_crab/1-models/models.ipynb
jupyter nbconvert --to html --embed-images notebooks/time_for_crab/2-features/features.ipynb
jupyter nbconvert --to html --embed-images notebooks/time_for_crab/3-evaluation/evaluation.ipynb

Export to LaTeX

To export the notebooks to LaTeX or PDF, you'll need some additional packages:

  • pandoc - install with pip install -e .[latex] from the project root.
  • texlive - install for your OS using the instructions here.
    • TexLive focuses more on user security than MikTeX, hence the recommendation.
    • This takes a while to install, so be patient.

Then use the following commands to generate the LaTeX files:

jupyter nbconvert --to latex notebooks/time_for_crab/0-eda/eda.ipynb

Or to generate the PDF files:

jupyter nbconvert --to pdf notebooks/time_for_crab/0-eda/eda.ipynb