nnaisense / evotorch

Advanced evolutionary computation library built directly on top of PyTorch, created at NNAISENSE.
https://evotorch.ai
Apache License 2.0
1.01k stars 63 forks source link

fix: Fix all the mkdocstrings warnings #39

Closed Higgcz closed 1 year ago

Higgcz commented 1 year ago

There were a lot of docstring issues, this MR fixes them all. Including a small bug that crawled into the evotorch.neuroevolution.net.statefulmodule.ensure_stateful(...) function.

codecov-commenter commented 1 year ago

Codecov Report

Merging #39 (fdad1c8) into master (b7e9d27) will decrease coverage by 0.00%. The diff coverage is 80.00%.

@@            Coverage Diff             @@
##           master      #39      +/-   ##
==========================================
- Coverage   52.19%   52.18%   -0.01%     
==========================================
  Files          43       43              
  Lines        6240     6241       +1     
==========================================
  Hits         3257     3257              
- Misses       2983     2984       +1     
Impacted Files Coverage Δ
src/evotorch/algorithms/distributed/gaussian.py 19.21% <ø> (ø)
src/evotorch/core.py 61.59% <ø> (ø)
src/evotorch/neuroevolution/net/vecrl.py 40.06% <ø> (ø)
src/evotorch/tools/objectarray.py 72.78% <ø> (ø)
src/evotorch/neuroevolution/net/statefulmodule.py 34.78% <50.00%> (-1.59%) :arrow_down:
src/evotorch/tools/misc.py 82.03% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Higgcz commented 1 year ago

Ready for merge