IBM / simulai

A toolkit with data-driven pipelines for physics-informed machine learning.
https://ibm.github.io/simulai/
Apache License 2.0
158 stars 23 forks source link

NumPy docstrings for the directory simulai/models #106

Closed Joao-L-S-Almeida closed 1 year ago

Joao-L-S-Almeida commented 1 year ago
TarikKaanKoc commented 1 year ago

I have added numpy docstrings to the following functions in the _pytorch_models/_autoencoder.py file:

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 1 year ago

Excellent. Thank you @TarikKaanKoc