Documentation page for each inference tool

inlab-geo / cofi

Common Framework for Inference

https://cofi.readthedocs.io/en/latest/

BSD 2-Clause "Simplified" License

17 stars 4 forks source link

Documentation page for each inference tool #181

Open jwhhh opened 5 months ago

jwhhh commented 5 months ago

Suggested by @auggiemarignier it would be ideal to have a page for each inference tool that CoFI links to, so that there is information about how to use it, especially the solver parameters (that can be dynamically generated for some tools).

Similar to how we generated all the pages for Epsresso problems with

https://github.com/inlab-geo/espresso/blob/main/espresso_machine/doc_utils/gen_docs.py
https://github.com/inlab-geo/espresso/blob/main/docs/source/_ext/generate_contrib_docs.py

auggiemarignier commented 5 months ago

Something to also make sure is in the docs is what attributes are actually saved in InversionResult. I've been burnt a couple times by just changing the tool and options in my scripts, but forgetting that each tool has different outputs samples, models, sampler etc.

Note to self: I guess there is always the option of just pickling the InversionResult instance...