thu-ml/tianshou

Use Altair inside a notebook to display benchmark results

Open

#1136 opened on May 4, 2024

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

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

Tech stack
python
Domain
documentation
Issue type
feature
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonAltairJupyter Notebooks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Review the current custom JS code for benchmark display (likely in docs/ or a utility file). Then explore how to integrate Altair charts into the existing notebook documentation. Look at example notebooks and the Altair documentation for creating interactive charts from pandas DataFrames. The goal is to replace the JS dependency entirely.