Feat/sahil/6 - Githubissues

PinguDevTeam / ICF-MI-framework

Model identifiability pipeline using surrogate models trained on a latent space extracted by tensor decompositions.

https://pingudevteam.github.io/ICF-MI-framework/

MIT License

0 stars 0 forks source link

Feat/sahil/6 #18

Closed sahilbhola14 closed 2 years ago

sahilbhola14 commented 2 years ago

Purpose

This PR addresses the auto-documentation issue that was raised to ensure the code base is automatically documented.

Closes #6

Sphinx is introduced to automatically document the code
Automation scripts are introduced in scripts to install sphinx and generate the documentation
TT-ICE has been renamed to TT_ICE !!
Relevant documentation has been done to auto-document the code via Sphinx

Type of change

New feature (non-breaking change which adds functionality)
Breaking change (non-backwards-compatible fix or feature)
Documentation update

Checklist

Put an x in the boxes that apply.

[x] My code functions as intended
[x] I have used camelCase in my variable and function names
[x] I have commented my code properly
[x] I have provided the necessary prompts for automatic documentation
[x] I have provided a toy case under the examples folder
[x] I have addressed all the issues entirely