diff --git a/README.md b/README.md index 872c8422309cdf13f3cf774a4455d79f5c7e261a..2ec57bbf2e55fe7e61edf4da212cbb944cb62c42 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,27 @@ pip install -e . `-e` can be omitted if you don't intend to modify the code in this package. -## Model Data for Example / Testing +## Getting Started + +The documentation page contains a full tutorial. +Build the documentation by: + +```bash +pip install sphinx sphinx_rtd_theme sphinx_autodoc_typehints +cd doc +make html +``` + +The documentation page will be created as `doc/build/html/index.html`. +You can open this in the browser and browse to "Getting Started" section. + +### Model Data for Example / Testing `predtuner` contains 10 demo models which are also used in tests. - Download and extract [this](https://drive.google.com/file/d/1V_yd9sKcZQ7zhnO5YhRpOsaBPLEEvM9u/view?usp=sharing) file containing all 10 models, for testing purposes. -- The example only uses VGG16-CIFAR10. If you don't need the other models, get the data for VGG16-CIFAR10 [here](https://drive.google.com/file/d/1Z84z-nsv_nbrr8t9i28UoxSJg-Sd_Ddu/view?usp=sharing). +- The "Getting Started" example on the documentation page only uses VGG16-CIFAR10. + If you don't need the other models, get the data for VGG16-CIFAR10 + [here](https://drive.google.com/file/d/1Z84z-nsv_nbrr8t9i28UoxSJg-Sd_Ddu/view?usp=sharing). In either case, there should be a `model_params/` folder at the root of repo after extraction. -