Emulator fix doc #101

marcosfelt · 2021-03-06T10:30:41Z

This aims to improve the documentation for the ExperimentalEmulator class (fixes #96).

Add docstrings to all public methods of ExperimentalEmualtor
Add example of saving and loading to benchmarks tutorial
Add a "where to start" to the homepage with links to both Emulator tutorial and the main tutorial.
Document ANNRegressor
Document RegressorRegistry
Document functions for getting pretrained models

marcosfelt added 10 commits March 6, 2021 10:18

Add in descriptors because they were missing

2324a1e

Improve documentation

909f6e9

Fix experimental emulator doctest issue

58f58c8

Descriptors now actually being tested

b74d88f

Update emulator docs

3960e24

Fix issue with loading descriptors pretrained baumgartner model

93e5cea

Create a separate tutorials directory inside docs

d701786

Add redirects from old tutorials links to new tutorials directory

cb6f1e3

Update RegressorRegistry docs

c9ed342

Fix typo in pyproject.toml

38651a1

marcosfelt merged commit e692a88 into master Mar 8, 2021

marcosfelt deleted the emulator_fix_doc branch April 6, 2021 09:07

Provide feedback