fossasia/visdom

[Feature Request] Display text windows when comparing environments

Open

#470 opened on Sep 1, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (9,831 stars) (1,152 forks)batch import
enhancementhelp wanted

Description

Currently, comparing environments compares only plots with the same title across envs. It would be useful to have a similar feature for text windows. In my setup, I create an env for each run of my experiment, and display some plots and a text window with some config info for each run. Comparing envs is an awesome feature which allows me to easily compare the plots across different runs. However, I can't easily compare the configs across runs.

A solution is to just display all text windows with the same title, and append an index (0, 1, 2,...) in the title of the compare env window as is the case for legends in plots.

It might be possible to simulate this behavior by displaying the configs in a 'plot' using a text annotation of some sort, but this seems too hacky.

Contributor guide

Tech stack
python
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonJavaScriptVisdom codebase understanding
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine how the comparison feature currently displays plots with the same title in Visdom. Look at the Python server code (likely in server.py) and the JavaScript client (in static/js/) to understand the rendering logic. Text windows are separate from plots, so you'll need to extend the comparison view to include text windows with the same title, appending an index like for legends. Check if there are existing functions for window type differentiation. The goal is to modify the comparison logic to collect and display text windows alongside plots.