thu-ml/tianshou

Use Altair inside a notebook to display benchmark results

Open

#1,136 opened on May 4, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (1,072 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (7,121 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Currently we rely on custom js code to render the benchmark results. That's very cumbersome and it took me quite some time to fix it last time, after some stuff there broke due to documentation updates.

Instead, now that we have notebooks as part of the docs, we could probably achieve the same display with altair and remove all custom js code

Contributor guide

Research direction
Study the existing custom JS benchmark display code, then replicate the visualizations using Altair in a Jupyter notebook. Ensure the new implementation is simpler and maintainable.
Tech stack
python
Domain
documentation
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65