Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update python version and ci #48

Merged
merged 8 commits into from
Feb 28, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: format_and_test
name: Tests and Linters 🧪

on: [ push, pull_request ]

@@ -9,7 +9,7 @@ jobs:
strategy:
fail-fast: false
matrix:
docker-image: ["python:3.8"]
docker-image: ["python:3.9", "python:3.10"]
steps:
- name: Checkout marl_eval
uses: actions/checkout@v2
10 changes: 5 additions & 5 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: pypi
name: Publish to PyPi 📦

on:
release:
@@ -16,11 +16,11 @@ jobs:
python-version: "3.x"
- name: Install dependencies
run: |
pip install --upgrade pip setuptools twine
pip install --upgrade pip hatch twine
- name: Build and publish
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
run: |
python setup.py sdist
hatch build
twine upload dist/*
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -4,6 +4,27 @@
<p>A tool for standardised experiment data aggregation for cooperative multi-agent reinforcement learning</p>
</h2>

<p align="center">
<a href="https://www.python.org/doc/versions/">
<img src="https://img.shields.io/badge/python-3.9%20%7C%203.10-blue" alt="Python Versions">
</a>
<a href="https://badge.fury.io/py/id-marl-eval">
<img src="https://badge.fury.io/py/id-marl-eval.svg" alt="PyPI version" height="18">
</a>
<a href="https://github.com/instadeepai/marl-eval/actions/workflows/ci.yaml">
<img src="https://github.com/instadeepai/marl-eval/actions/workflows/ci.yaml/badge.svg" alt="Tests and linters">
</a>
<a href="https://github.com/psf/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code Style">
</a>
<a href="http://mypy-lang.org/">
<img src="http://www.mypy-lang.org/static/mypy_badge.svg" alt="MyPy">
</a>
<a href="https://opensource.org/licenses/Apache-2.0">
<img src="https://img.shields.io/badge/License-Apache%202.0-orange.svg" alt="License">
</a>
</p>

## Welcome to MARL-eval 🧪
`marl-eval` is an open-source Python package for simplifying and standardising the statistical aggregation and plotting of cooperative multi-agent reinforcement learning experimental data.

@@ -28,7 +49,7 @@ Or to install directly from source:
```bash
pip install "git+https://github.com/instadeepai/marl-eval.git"
```
It should be noted that we have tested `marl-eval` on Python 3.8.
It should be noted that we have tested `marl-eval` on Python 3.9 and 3.10.

## Quickstart ⚡

3 changes: 2 additions & 1 deletion marl_eval/plotting_tools/plot_utils.py
Original file line number Diff line number Diff line change
@@ -19,6 +19,7 @@
import numpy as np
import seaborn as sns
from matplotlib.axes import Axes
from matplotlib.figure import Figure
from rliable.plot_utils import _annotate_and_decorate_axis


@@ -36,7 +37,7 @@ def plot_single_task_curve(
legend_map: Optional[Dict] = None,
run_times: Optional[Dict] = None,
**kwargs: Any,
) -> Axes:
) -> Figure:
"""Plots an aggregate metric with CIs as a function of environment frames.

Args:
6 changes: 3 additions & 3 deletions requirements/requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
pre-commit
mypy==0.941
flake8==3.8.2
black==22.3.0
mypy
flake8
black
interrogate
pydocstyle
types-six
Loading