Coverage and docs

[KornbergFresnel]

improve coverage and docs, also the CI/CD

[codecov[bot]]

Codecov Report

Merging #49 (a99a7c0) into main (ac41de3) will increase coverage by 45.82%. The diff coverage is 95.74%.

@@             Coverage Diff             @@
##             main      #49       +/-   ##
===========================================
+ Coverage   36.36%   82.19%   +45.82%     
===========================================
  Files          53       36       -17     
  Lines        4314     2482     -1832     
===========================================
+ Hits         1569     2040      +471     
+ Misses       2745      442     -2303     

Impacted Files	Coverage Δ
malib/rollout/inference/ray/client.py	80.34% <ø> (+60.34%)	:arrow_up:
malib/rollout/manager.py	76.71% <ø> (+43.83%)	:arrow_up:
malib/rollout/pb_rolloutworker.py	100.00% <ø> (+61.90%)	:arrow_up:
malib/agent/agent_interface.py	72.46% <86.66%> (+46.53%)	:arrow_up:
malib/backend/offline_dataset_server.py	90.00% <100.00%> (-8.56%)	:arrow_down:
malib/common/payoff_manager.py	89.25% <100.00%> (+68.28%)	:arrow_up:
malib/rollout/envs/env.py	54.18% <100.00%> (+3.93%)	:arrow_up:
malib/rollout/envs/vector_env.py	88.09% <100.00%> (+54.49%)	:arrow_up:
malib/rollout/rolloutworker.py	91.75% <100.00%> (+69.35%)	:arrow_up:
malib/scenarios/psro_scenario.py	94.54% <100.00%> (+62.40%)	:arrow_up:
... and 28 more

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

[lgtm-com[bot]]

This pull request introduces 9 alerts and fixes 35 when merging a99a7c014f026ee9507c539a9855e0d72d7396e3 into ac41de39101de7c30bb687f28936f7b8b54bf7a5 - view on LGTM.com

new alerts:

• 4 for Missing call to `__init__` during object initialization
• 3 for `__init__` method calls overridden method
• 1 for Module is imported more than once
• 1 for Unused import

fixed alerts:

• 14 for Unused import
• 5 for Module is imported with 'import' and 'import from'
• 5 for Variable defined multiple times
• 4 for Redundant comparison
• 3 for Wrong number of arguments in a call
• 2 for Wrong name for an argument in a call
• 1 for Missing call to `__init__` during object initialization

• 1 for `__init__` method calls overridden method

Heads-up: LGTM.com's PR analysis will be disabled on the 5th of December, and LGTM.com will be shut down ⏻ completely on the 16th of December 2022. Please enable GitHub code scanning, which uses the same CodeQL engine :gear: that powers LGTM.com. For more information, please check out our post on the GitHub blog.