instadeepai / Mava

šŸ¦ A research-friendly codebase for fast experimentation of multi-agent reinforcement learning in JAX

Home Page:https://id-mava.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[FEATURE] Move pre-commit hooks to ruff

callumtilbury opened this issue Ā· comments

Feature

There have been many discussions to move our python tooling to ruff, as seen in many popular libraries in the community. This will be a big once-off effort, but will make our pre-commit hooks much faster.

Proposal

Once-off big push to use ruff's tooling. Will need to match current settings to those in ruff in the best way possible.

Testing

Tested by inspection, to see if we're happy with the formatting styles from ruff.

Benchmarking (Optional)

n/a

Definition of done

When ruff is used for our pre-commit hooks in Mava.

Mandatory checklist before making a PR

  • The success criteria laid down in ā€œDefinition of doneā€ are met.
  • Code is documented - docstrings for methods and classes, static types for arguments.
  • Code is tested - unit, integration and/or functional tests are added.
  • Documentation is updated - README, CONTRIBUTING, or other documentation.
  • All functional tests are green.
  • Link experiment/benchmarking after implementation (optional).

Links / references / screenshots

https://github.com/astral-sh/ruff