NumPy docstrings for the directory simulai/models
Joao-L-S-Almeida opened this issue · 2 comments
Joao-L-S-Almeida commented
- simulai/models/_pytorch_models/_autoencoder.py
- simulai/models/_pytorch_models/_deeponet.py
- simulai/models/_pytorch_models/_miscellaneous.py
TarikKaanKoc commented
I have added numpy docstrings to the following functions in the _pytorch_models/_autoencoder.py file:
- summary
- _projection_with_bottleneck
- _projection
- _reconstruction_with_bottleneck
- _reconstruction
- Mu
- Sigma
- CoVariance
- latent_gaussian_noisy
- reconstruction_forward
- reconstruction_eval
- project
- reconstruct
- eval
and etc..
The docstrings provide detailed explanations of each function's purpose, parameters, and return values, as well as example usage. I believe this will make the code more understandable and easier to maintain.
Please let me know if there are any issues or concerns with these changes.
Thank you! @Joao-L-S-Almeida
Joao-L-S-Almeida commented
Excellent. Thank you @TarikKaanKoc