{"author":"Jack Urbanek, Allan Jabri, Laurens van der Maaten","author_email":"jju@fb.com","bugtrack_url":null,"classifiers":[],"description":"\n\n

\n
\n $\"Logo\"/$

\n Creating, organizing & sharing visualizations of live, rich data. Supports Python.\n

\n\n\n

Jump To: Setup, Usage, API, Customizing, Contributing, License\n

\n\n\n

\n \n \n \n \n

\n\n\n

\nVisdom aims to facilitate visualization of (remote) data with an emphasis on supporting scientific experimentation.
\nBroadcast visualizations of plots, images, and text for yourself and your collaborators.\nOrganize your visualization space programmatically or through the UI to create dashboards for live data, inspect results of experiments, or debug experimental code.\n

\n\n

\n \n

\n \n \n

\n\n## Concepts\nVisdom has a simple set of features that can be composed for various use-cases.\n\n

Windows

\n\n

\n\nThe UI begins as a blank slate – you can populate it with plots, images, and text. These appear in windows that you can drag, drop, resize, and destroy. The windows live in `envs` and the state of `envs` is stored across sessions. You can download the content of windows – including your plots in `svg`.\n\n> **Tip**: You can use the zoom of your browser to adjust the scale of the UI.\n

Callbacks

\n\nThe python Visdom implementation supports callbacks on a window. The demo shows an example of this in the form of an editable text pad. The functionality of these callbacks allows the Visdom object to receive and react to events that happen in the frontend.\n\nYou can subscribe a window to events by adding a function to the event handlers dict for the window id you want to subscribe by calling `viz.register_event_handler(handler, win_id)` with your handler and the window id. Multiple handlers can be registered to the same window. You can remove all event handlers from a window using `viz.clear_event_handlers(win_id)`. When an event occurs to that window, your callbacks will be called on a dict containing:\n\n - `event_type`: one of the below event types\n - `pane_data`: all of the stored contents for that window including layout and content.\n - `eid`: the current environment id\n - `target`: the window id the event is called on\n\nAdditional parameters are defined below.\n\nRight now the following callback events are supported:\n\n1. `Close` - Triggers when a window is closed. Returns a dict with only the aforementioned fields.\n2. `KeyPress` - Triggers when a key is pressed. Contains additional parameters:\n - `key` - A string representation of the key pressed (applying state modifiers such as SHIFT)\n - `key_code` - The javascript event keycode for the pressed key (no modifiers)\n3. `PropertyUpdate` - Triggers when a property is updated in Property pane\n - `propertyId` - Position in properties list\n - `value` - New property value\n4. `Click` - Triggers when Image pane is clicked on, has a parameter:\n - `image_coord` - dictionary with the fields `x` and `y` for the click coordinates in the coordinate frame of the possibly zoomed/panned image (*not* the enclosing pane).\n\n

\n\n

Editable Plot Parameters

\nUse the top-right *edit*-Button to inspect all parameters used for plot in the respective window. \nThe visdom client supports dynamic change of plot parameters as well. Just change one of the listed parameters, the plot will be altered on-the-fly. \nClick the button again to close the property list.\n

\n\n\n

Environments

\n\nYou can partition your visualization space with `envs`. By default, every user will have an env called `main`. New envs can be created in the UI or programmatically. The state of envs is chronically saved. Environments are able to keep entirely different pools of plots.\n\nYou can access a specific env via url: `http://localhost.com:8097/env/main`. If your server is hosted, you can share this url so others can see your visualizations too.\n\nEnvironments are automatically hierarchically organized by the first `_`.\n\n#### Selecting Environments\n

\n\nFrom the main page it is possible to toggle between different environments using the environment selector. Selecting a new environment will query the server for the plots that exist in that environment. The environment selector allows for searching and filtering for the new enironment.\n\n#### Comparing Environments\n\nFrom the main page it is possible to compare different environments using the environment selector. Selecting multiple environments in the check box will query the server for the plots with the same titles in all environments and plot them in a single plot. An additional compare legend pane is created with a number corresponding to each selected environment. Individual plots are updated with legends corresponding to \"x_name\" where `x` is a number corresponding with the compare legend pane and `name` is the original name in the legend.\n\n> **Note**: The compare envs view is not robust to high throughput data, as the server is responsible for generating the compared content. Do not compare an environment that is receiving a high quantity of updates on any plot, as every update will request regenerating the comparison. If you need to compare two plots that are receiving high quantities of data, have them share the same window on a singular env.\n\n#### Clearing Environments\nYou can use the eraser button to remove all of the current contents of an environment. This closes the plot windows for that environment but keeps the empty environment for new plots.\n\n#### Managing Environments\n

\n\nPressing the folder icon opens a dialog that allows you to fork or force save the current environment, or delete any of your existing environments. Use of this feature is fully described in the **State** section.\n\n>**Env Files:**\n>Your envs are loaded upon request by the user, by default from `$HOME/.visdom/`. Custom paths can be passed as a cmd-line argument. Envs are removed by using the delete button or by deleting the corresponding `.json` file from the env dir. In case you want the server to pre-load all files into cache, use the flag `-eager_data_loading`.\n\n

\n\n\n

State

\n\nOnce you've created a few visualizations, state is maintained. The server automatically caches your visualizations -- if you reload the page, your visualizations reappear.\n\n

\n\n\n* **Save:** You can manually do so with the `save` button. This will serialize the env's state (to disk, in JSON), including window positions. You can save an `env` programmatically.\n
This is helpful for more sophisticated visualizations in which configuration is meaningful, e.g. a data-rich demo, a model training dashboard, or systematic experimentation. This also makes them easy to share and reuse.\n\n* **Fork:** If you enter a new env name, saving will create a new env -- effectively **forking** the previous env.\n\n> **Tip**: Fork an environment before you begin to make edits to ensure that your changes are saved seperately.\n\n### Filter\nYou can use the `filter` to dynamically sift through windows present in an env -- just provide a regular expression with which to match titles of window you want to show. This can be helpful in use cases involving an env with many windows e.g. when systematically checking experimental results.\n\n

\n\n> **Note**: If you have saved your current view, the view will be restored after clearing the filter.\n>

\n\n### Views\n

\n\nIt is possible to manage the views simply by dragging the tops of windows around, however additional features exist to keep views organized and save common views. View management can be useful for saving and switching between multiple common organizations of your windows.\n\n#### Saving/Deleting Views\nUsing the folder icon, a dialog window opens where views can be forked in the same way that envs can be. Saving a view will retain the position and sizes of all of the windows in a given environment. Views are saved in `$HOME/.visdom/view/layouts.json` in the visdom filepath.\n\n> **Note**: Saved views are static, and editing a saved view copies that view over to the `current` view where editing can occur.\n\n#### Re-Packing\nUsing the repack icon (9 boxes), visdom will attempt to pack your windows in a way that they best fit while retaining row/column ordering.\n\n> **Note**: Due to the reliance on row/column ordering and `ReactGridLayout` the final layout might be slightly different than what might be expected. We're working on improving that experience or providing alternatives that give more fine-tuned control.\n\n#### Reloading Views\n

\n\nUsing the view dropdown it is possible to select previously saved views, restoring the locations and sizes of all of the windows within the current environment to the places they were when that view was saved last.\n

\n\n\n\n\n\n## Setup\nPython and web clients come bundled with the python server.\n\nInstall from pip\n```bash\n> pip install visdom\n```\n\nInstall from source\n```bash\n> pip install git+https://github.com/fossasia/visdom\n```\n\n## Usage\n\nStart the server (probably in a `screen` or `tmux`) from the command line:\n\n```bash\n> visdom\n```\n\nVisdom now can be accessed by going to `http://localhost:8097` in your browser, or your own host address if specified.\n\n> The `visdom` command is equivalent to running `python -m visdom.server`.\n\n>If the above does not work, try using an SSH tunnel to your server by adding the following line to your local `~/.ssh/config`:\n```LocalForward 127.0.0.1:8097 127.0.0.1:8097```.\n\n#### Command Line Options\n\nThe following options can be provided to the server:\n\n1. `-port` : The port to run the server on.\n2. `-hostname` : The hostname to run the server on.\n3. `-base_url` : The base server url (default = /).\n4. `-env_path` : The path to the serialized session to reload.\n5. `-logging_level` : Logging level (default = INFO). Accepts both standard text and numeric logging values.\n6. `-readonly` : Flag to start server in readonly mode.\n7. `-enable_login` : Flag to setup authentication for the sever, requiring a username and password to login.\n8. `-force_new_cookie` : Flag to reset the secure cookie used by the server, invalidating current login cookies.\nRequires `-enable_login`.\n9. `-bind_local` : Flag to make the server accessible only from localhost.\n10. `-eager_data_loading` : By default visdom loads environments lazily upon user request. Setting this flag lets visdom pre-fetch all environments upon startup.\n\nWhen `-enable_login` flag is provided, the server asks user to input credentials using terminal prompt. Alternatively,\nyou can setup `VISDOM_USE_ENV_CREDENTIALS` env variable, and then provide your username and password via\n`VISDOM_USERNAME` and `VISDOM_PASSWORD` env variables without manually interacting with the terminal. This setup\nis useful in case if you would like to launch `visdom` server from bash script, or from Jupyter notebook.\n```bash\nVISDOM_USERNAME=username\nVISDOM_PASSWORD=password\nVISDOM_USE_ENV_CREDENTIALS=1 visdom -enable_login\n```\nYou can also use `VISDOM_COOKIE` variable to provide cookies value if the cookie file wasn't generated, or the\nflag `-force_new_cookie` was set.\n\n#### Python example\n```python\nimport visdom\nimport numpy as np\nvis = visdom.Visdom()\nvis.text('Hello, world!')\nvis.image(np.ones((3, 10, 10)))\n```\n\n### Demos\nIf you have cloned this repository, you can run our demo showcase.\n```bash\npython example/demo.py\n```\n\n\n## API\nFor a quick introduction into the capabilities of `visdom`, have a look at the `example` directory, or read the details below.\n\n### Visdom Arguments (Python only)\nThe python visdom client takes a few options:\n- `server`: the hostname of your visdom server (default: `'http://localhost'`)\n- `port`: the port for your visdom server (default: `8097`)\n- `base_url`: the base visdom server url (default: `/`)\n- `env`: Default environment to plot to when no `env` is provided (default: `main`)\n- `raise_exceptions`: Raise exceptions upon failure rather than printing them (default: `True` (soon))\n- `log_to_filename`: If not none, log all plotting and updating events to the given file (append mode) so that they can be replayed later using `replay_log` (default: `None`)\n- `use_incoming_socket`: enable use of the socket for receiving events from the web client, allowing user to register callbacks (default: `True`)\n- `http_proxy_host`: Deprecated. Use Proxies argument for complete proxy support.\n- `http_proxy_port`: Deprecated. Use Proxies argument for complete proxy support.\n- `username`: username to use for authentication, if server started with `-enable_login` (default: `None`)\n- `password`: password to use for authentication, if server started with `-enable_login` (default: `None`)\n- `proxies`: Dictionary mapping protocol to the URL of the proxy (e.g. {`http`: `foo.bar:3128`}) to be used on each Request. (default: `None`)\n- `offline`: Flag to run visdom in offline mode, where all requests are logged to file rather than to the server. Requires `log_to_filename` is set. In offline mode, all visdom commands that don't create or update plots will simply return `True`. (default: `False`)\n\nOther options are either currently unused (endpoint, ipv6) or used for internal functionality.\n\n### Basics\nVisdom offers the following basic visualization functions:\n- [`vis.image`](#visimage) : image\n- [`vis.images`](#visimages) : list of images\n- [`vis.text`](#vistext) : arbitrary HTML\n- [`vis.properties`](#visproperties) : properties grid\n- [`vis.audio`](#visaudio) : audio\n- [`vis.video`](#visvideo) : videos\n- [`vis.svg`](#vissvg) : SVG object\n- [`vis.matplot`](#vismatplot) : matplotlib plot\n- [`vis.save`](#vissave) : serialize state server-side\n\n### Plotting\nWe have wrapped several common plot types to make creating basic visualizations easily. These visualizations are powered by [Plotly](https://plot.ly/).\n\nThe following API is currently supported:\n- [`vis.scatter`](#visscatter) : 2D or 3D scatter plots\n- [`vis.line`](#visline) : line plots\n- [`vis.stem`](#visstem) : stem plots\n- [`vis.heatmap`](#visheatmap) : heatmap plots\n- [`vis.bar`](#visbar) : bar graphs\n- [`vis.histogram`](#vishistogram) : histograms\n- [`vis.boxplot`](#visboxplot) : boxplots\n- [`vis.surf`](#vissurf) : surface plots\n- [`vis.contour`](#viscontour) : contour plots\n- [`vis.quiver`](#visquiver) : quiver plots\n- [`vis.mesh`](#vismesh) : mesh plots\n- [`vis.dual_axis_lines`](#visdual_axis_lines) : double y axis line plots\n\n### Generic Plots\nNote that the server API adheres to the Plotly convention of `data` and `layout` objects, such that you can produce your own arbitrary `Plotly` visualizations:\n\n```python\nimport visdom\nvis = visdom.Visdom()\n\ntrace = dict(x=[1, 2, 3], y=[4, 5, 6], mode=\"markers+lines\", type='custom',\n marker={'color': 'red', 'symbol': 104, 'size': \"10\"},\n text=[\"one\", \"two\", \"three\"], name='1st Trace')\nlayout = dict(title=\"First Plot\", xaxis={'title': 'x1'}, yaxis={'title': 'x2'})\n\nvis._send({'data': [trace], 'layout': layout, 'win': 'mywin'})\n```\n\n### Others\n- [`vis.close`](#visclose) : close a window by id\n- [`vis.delete_env`](#visdelete_env) : delete an environment by env_id\n- [`vis.win_exists`](#viswin_exists) : check if a window already exists by id\n- [`vis.get_env_list`](#visget_env_list) : get a list of all of the environments on your server\n- [`vis.win_hash`](#viswin_hash): get md5 hash of window's contents\n- [`vis.get_window_data`](#visget_window_data): get current data for a window\n- [`vis.check_connection`](#vischeck_connection): check if the server is connected\n- [`vis.replay_log`](#visreplay_log): replay the actions from the provided log file\n\n\n## Details\n

\n\n### Basics\n\n#### vis.image\nThis function draws an `img`. It takes as input an `CxHxW` tensor `img`\nthat contains the image.\n\nThe following `opts` are supported:\n\n- `jpgquality`: JPG quality (`number` 0-100). If defined image will be saved as JPG to reduce file size. If not defined image will be saved as PNG.\n- `caption`: Caption for the image\n- `store_history`: Keep all images stored to the same window and attach a slider to the bottom that will let you select the image to view. You must always provide this opt when sending new images to an image with history.\n\n> **Note** You can use alt on an image pane to view the x/y coordinates of the cursor. You can also ctrl-scroll to zoom, alt scroll to pan vertically, and alt-shift scroll to pan horizontally. Double click inside the pane to restore the image to default.\n\n\n#### vis.images\n\nThis function draws a list of `images`. It takes an input `B x C x H x W` tensor or a `list of images` all of the same size. It makes a grid of images of size (B / nrow, nrow).\n\nThe following arguments and `opts` are supported:\n\n- `nrow`: Number of images in a row\n- `padding`: Padding around the image, equal padding around all 4 sides\n- `opts.jpgquality`: JPG quality (`number` 0-100). If defined image will be saved as JPG to reduce file size. If not defined image will be saved as PNG.\n- `opts.caption`: Caption for the image\n\n#### vis.text\nThis function prints text in a box. You can use this to embed arbitrary HTML.\nIt takes as input a `text` string.\nNo specific `opts` are currently supported.\n\n#### vis.properties\nThis function shows editable properties in a pane. Properties are expected to be a List of Dicts e.g.:\n```\n properties = [\n {'type': 'text', 'name': 'Text input', 'value': 'initial'},\n {'type': 'number', 'name': 'Number input', 'value': '12'},\n {'type': 'button', 'name': 'Button', 'value': 'Start'},\n {'type': 'checkbox', 'name': 'Checkbox', 'value': True},\n {'type': 'select', 'name': 'Select', 'value': 1, 'values': ['Red', 'Green', 'Blue']},\n ]\n```\nSupported types:\n - text: string\n - number: decimal number\n - button: button labeled with \"value\"\n - checkbox: boolean value rendered as a checkbox\n - select: multiple values select box\n - `value`: id of selected value (zero based)\n - `values`: list of possible values\n\nCallback are called on property value update:\n - `event_type`: `\"PropertyUpdate\"`\n - `propertyId`: position in the `properties` list\n - `value`: new value\n\nNo specific `opts` are currently supported.\n\n#### vis.audio\nThis function plays audio. It takes as input the filename of the audio\nfile or an `N` tensor containing the waveform (use an `Nx2` matrix for stereo\naudio). The function does not support any plot-specific `opts`.\n\nThe following `opts` are supported:\n\n- `opts.sample_frequency`: sample frequency (`integer` > 0; default = 44100)\n\nKnown issue: Visdom uses scipy to convert tensor inputs to wave files. Some\nversions of Chrome are known not to play these wave files (Firefox and Safari work fine).\n\n#### vis.video\nThis function plays a video. It takes as input the filename of the video\n`videofile` or a `LxHxWxC`-sized\n`tensor` containing all the frames of the video as input. The\nfunction does not support any plot-specific `opts`.\n\nThe following `opts` are supported:\n\n- `opts.fps`: FPS for the video (`integer` > 0; default = 25)\n\nNote: Using `tensor` input requires that ffmpeg is installed and working.\nYour ability to play video may depend on the browser you use: your browser has\nto support the Theano codec in an OGG container (Chrome supports this).\n\n#### vis.svg\nThis function draws an SVG object. It takes as input a SVG string `svgstr` or\nthe name of an SVG file `svgfile`. The function does not support any specific\n`opts`.\n\n#### vis.matplot\nThis function draws a Matplotlib `plot`. The function supports\none plot-specific option: `resizable`.\n\n> **Note** When set to `True` the plot is resized with the\npane. You need `beautifulsoup4` and `lxml`\npackages installed to use this option.\n\n> **Note**: `matplot` is not rendered using the same backend as plotly plots, and is somewhat less efficient. Using too many matplot windows may degrade visdom performance.\n\n#### vis.plotlyplot\n\nThis function draws a Plotly `Figure` object. It does not explicitly take options as it assumes you have already explicitly configured the figure's `layout`.\n\n> **Note** You must have the `plotly` Python package installed to use this function. It can typically be installed by running `pip install plotly`.\n\n#### vis.embeddings\n\nThis function visualizes a collection of features using the [Barnes-Hut t-SNE algorithm](https://github.com/lvdmaaten/bhtsne).\n\nThe function accepts the following arguments:\n- `features`: a list of tensors\n- `labels`: a list of corresponding labels for the tensors provided for `features`\n- `data_getter=fn`: (optional) a function that takes as a parameter an index into the features array and returns a summary representation of the tensor. If this is set, `data_type` must also be set.\n- `data_type=str`: (optional) currently the only acceptable value here is `\"html\"`\n\nWe currently assume that there are no more than 10 unique labels, in the future we hope to provide a colormap in opts for other cases.\n\nFrom the UI you can also draw a lasso around a subset of features. This will rerun the t-SNE visualization on the selected subset.\n\n#### vis.save\nThis function saves the `envs` that are alive on the visdom server. It takes input a list of env ids to be saved.\n\n### Plotting\nFurther details on the wrapped plotting functions are given below.\n\nThe exact inputs into the plotting functions vary, although most of them take as input a tensor `X` than contains the data and an (optional) tensor `Y` that contains optional data variables (such as labels or timestamps). All plotting functions take as input an optional `win` that can be used to plot into a specific window; each plotting function also returns the `win` of the window it plotted in. One can also specify the `env` to which the visualization should be added.\n\n#### vis.scatter\n\nThis function draws a 2D or 3D scatter plot. It takes as input an `Nx2` or\n`Nx3` tensor `X` that specifies the locations of the `N` points in the\nscatter plot. An optional `N` tensor `Y` containing discrete labels that\nrange between `1` and `K` can be specified as well -- the labels will be\nreflected in the colors of the markers.\n\n`update` can be used to efficiently update the data of an existing plot. Use `'append'` to append data, `'replace'` to use new data, or `'remove'` to remove the trace specified by `name`.\nUsing `update='append'` will create a plot if it doesn't exist and append to the existing plot otherwise.\nIf updating a single trace, use `name` to specify the name of the trace to be updated. Update data that is all NaN is ignored (can be used for masking update).\n\n\nThe following `opts` are supported:\n\n- `opts.markersymbol` : marker symbol (`string`; default = `'dot'`)\n- `opts.markersize` : marker size (`number`; default = `'10'`)\n- `opts.markercolor` : color per marker. (`torch.*Tensor`; default = `nil`)\n- `opts.markerborderwidth`: marker border line width (`float`; default = 0.5)\n- `opts.legend` : `table` containing legend names\n- `opts.textlabels` : text label for each point (`list`: default = `None`)\n- `opts.layoutopts` : dict of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n- `opts.traceopts` : dict mapping trace names or indices to dicts of additional options that the graph backend accepts. For example `traceopts = {'plotly': {'myTrace': {'mode': 'markers'}}}`.\n- `opts.webgl` : use WebGL for plotting (`boolean`; default = `false`). It is faster if a plot contains too many points. Use sparingly as browsers won't allow more than a couple of WebGL contexts on a single page.\n\n`opts.markercolor` is a Tensor with Integer values. The tensor can be of size `N` or `N x 3` or `K` or `K x 3`.\n\n- Tensor of size `N`: Single intensity value per data point. 0 = black, 255 = red\n- Tensor of size `N x 3`: Red, Green and Blue intensities per data point. 0,0,0 = black, 255,255,255 = white\n- Tensor of size `K` and `K x 3`: Instead of having a unique color per data point, the same color is shared for all points of a particular label.\n\n#### vis.sunburst\nThis function draws a sunburst chart. It takes two inputs: `parents` and `labels` array.\nvalues from `parents` array is used as parents object, like it define above which sector \nshould the this sector shown. values from `labels` array is used to define sector's label \nor you can say name. keep in mind that lenght of array `parents` and `labels` should be \nequal. There is a third array that you can pass to which is `value`, it is use to show \na value on hovering over a sector, it is optional argument, but if you are passing it then\nkeep in mind lenght of `values` should be equal to `parents` or `labels`.\n\nFollowing `opts` are currently supported:\n- `opts.font_size` : define font size of label (`int`)\n- `opts.font_color` : define font color of label (`string`)\n- `opts.opacity` : define opacity of chart (`float`)\n- `opts.line_width` : define distance between two sectors and sector to its parents (`int`)\n\n\n#### vis.line\nThis function draws a line plot. It takes as input an `N` or `NxM` tensor\n`Y` that specifies the values of the `M` lines (that connect `N` points)\nto plot. It also takes an optional `X` tensor that specifies the\ncorresponding x-axis values; `X` can be an `N` tensor (in which case all\nlines will share the same x-axis values) or have the same size as `Y`.\n\n`update` can be used to efficiently update the data of an existing plot. Use 'append' to append data, 'replace' to use new data, or 'remove' to remove the trace specified by `name`. If updating a single trace, use `name` to specify the name of the trace to be updated. Update data that is all NaN is ignored (can be used for masking update).\n\n**Smoothing**: Line plots can be smoothened using [Savitzky-Golay filtering](https://en.wikipedia.org/wiki/Savitzky%E2%80%93Golay_filter). This feature can be enabled by clicking the `~`-symbol in the top right corner of a window that contains a line plot.\n\n![Demo of interactive smoothing.](https://user-images.githubusercontent.com/19650074/159366736-1f5d8099-0ea5-4a3b-af17-49d3e24cb32c.gif)\n\nThe following `opts` are supported:\n\n- `opts.fillarea` : fill area below line (`boolean`)\n- `opts.markers` : show markers (`boolean`; default = `false`)\n- `opts.markersymbol`: marker symbol (`string`; default = `'dot'`)\n- `opts.markersize` : marker size (`number`; default = `'10'`)\n- `opts.linecolor` : line colors (`np.array`; default = None)\n- `opts.dash` : line dash type for each line (`np.array`; default = 'solid'), one of `solid`, `dash`, `dashdot` or `dash`, size should match number of lines being drawn\n- `opts.legend` : `table` containing legend names\n- `opts.layoutopts` : `dict` of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n- `opts.traceopts` : `dict` mapping trace names or indices to `dict`s of additional options that plot.ly accepts for a trace.\n- `opts.webgl` : use WebGL for plotting (`boolean`; default = `false`). It is faster if a plot contains too many points. Use sparingly as browsers won't allow more than a couple of WebGL contexts on a single page.\n\n\n#### vis.stem\nThis function draws a stem plot. It takes as input an `N` or `NxM` tensor\n`X` that specifies the values of the `N` points in the `M` time series.\nAn optional `N` or `NxM` tensor `Y` containing timestamps can be specified\nas well; if `Y` is an `N` tensor then all `M` time series are assumed to\nhave the same timestamps.\n\nThe following `opts` are supported:\n\n- `opts.colormap`: colormap (`string`; default = `'Viridis'`)\n- `opts.legend` : `table` containing legend names\n- `opts.layoutopts` : `dict` of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n\n#### vis.heatmap\nThis function draws a heatmap. It takes as input an `NxM` tensor `X` that\nspecifies the value at each location in the heatmap.\n\n`update` can be used to efficiently update the data of an existing plot. Use 'appendRow' to append data row-wise, 'appendColumn' to append data column-wise, 'prependRow' to prepend data row-wise, 'prependColumn' to prepend data column-wise, 'replace' to use new data, or 'remove' to remove the plot specified by `win`.\n\nThe following `opts` are supported:\n\n- `opts.colormap` : colormap (`string`; default = `'Viridis'`)\n- `opts.xmin` : clip minimum value (`number`; default = `X:min()`)\n- `opts.xmax` : clip maximum value (`number`; default = `X:max()`)\n- `opts.columnnames`: `table` containing x-axis labels\n- `opts.rownames` : `table` containing y-axis labels\n- `opts.layoutopts` : `dict` of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n- `opts.nancolor` : color for plotting `NaN`s. If this is `None`, `NaN`s will be plotted as transparent. (`string`; default = `None`)\n\n#### vis.bar\nThis function draws a regular, stacked, or grouped bar plot. It takes as\ninput an `N` or `NxM` tensor `X` that specifies the height of each of the\nbars. If `X` contains `M` columns, the values corresponding to each row\nare either stacked or grouped (depending on how `opts.stacked` is\nset). In addition to `X`, an (optional) `N` tensor `Y` can be specified\nthat contains the corresponding x-axis values.\n\nThe following plot-specific `opts` are currently supported:\n\n- `opts.rownames`: `table` containing x-axis labels\n- `opts.stacked` : stack multiple columns in `X`\n- `opts.legend` : `table` containing legend labels\n- `opts.layoutopts` : `dict` of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n\n#### vis.histogram\nThis function draws a histogram of the specified data. It takes as input\nan `N` tensor `X` that specifies the data of which to construct the\nhistogram.\n\nThe following plot-specific `opts` are currently supported:\n\n- `opts.numbins`: number of bins (`number`; default = 30)\n- `opts.layoutopts` : `dict` of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n\n#### vis.boxplot\nThis function draws boxplots of the specified data. It takes as input\nan `N` or an `NxM` tensor `X` that specifies the `N` data values of which\nto construct the `M` boxplots.\n\nThe following plot-specific `opts` are currently supported:\n\n- `opts.legend`: labels for each of the columns in `X`\n- `opts.layoutopts` : `dict` of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n\n#### vis.surf\nThis function draws a surface plot. It takes as input an `NxM` tensor `X`\nthat specifies the value at each location in the surface plot.\n\nThe following `opts` are supported:\n\n- `opts.colormap`: colormap (`string`; default = `'Viridis'`)\n- `opts.xmin` : clip minimum value (`number`; default = `X:min()`)\n- `opts.xmax` : clip maximum value (`number`; default = `X:max()`)\n- `opts.layoutopts` : `dict` of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n\n#### vis.contour\nThis function draws a contour plot. It takes as input an `NxM` tensor `X`\nthat specifies the value at each location in the contour plot.\n\nThe following `opts` are supported:\n\n- `opts.colormap`: colormap (`string`; default = `'Viridis'`)\n- `opts.xmin` : clip minimum value (`number`; default = `X:min()`)\n- `opts.xmax` : clip maximum value (`number`; default = `X:max()`)\n- `opts.layoutopts` : `dict` of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n\n#### vis.quiver\nThis function draws a quiver plot in which the direction and length of the\narrows is determined by the `NxM` tensors `X` and `Y`. Two optional `NxM`\ntensors `gridX` and `gridY` can be provided that specify the offsets of\nthe arrows; by default, the arrows will be done on a regular grid.\n\nThe following `opts` are supported:\n\n- `opts.normalize`: length of longest arrows (`number`)\n- `opts.arrowheads`: show arrow heads (`boolean`; default = `true`)\n- `opts.layoutopts` : `dict` of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n\n#### vis.mesh\nThis function draws a mesh plot from a set of vertices defined in an\n`Nx2` or `Nx3` matrix `X`, and polygons defined in an optional `Mx2` or\n`Mx3` matrix `Y`.\n\nThe following `opts` are supported:\n\n- `opts.color`: color (`string`)\n- `opts.opacity`: opacity of polygons (`number` between 0 and 1)\n- `opts.layoutopts` : `dict` of any additional options that the graph backend accepts for a layout. For example `layoutopts = {'plotly': {'legend': {'x':0, 'y':0}}}`.\n\n#### vis.dual_axis_lines\nThis function will create a line plot using plotly with different Y-Axis.\n\n`X` = A numpy array of the range.\n\n`Y1` = A numpy array of the same count as `X`.\n\n`Y2` = A numpy array of the same count as `X`.\n\nThe following `opts` are supported:\n\n- `opts.height` : Height of the plot\n- `opts.width` : Width of the plot\n- `opts.name_y1` : Axis name for Y1 plot\n- `opts.name_y2` : Axis name for Y2 plot\n- `opts.title` : Title of the plot\n- `opts.color_title_y1` : Color of the Y1 axis Title\n- `opts.color_tick_y1` : Color of the Y1 axis Ticks\n- `opts.color_title_y2` : Color of the Y2 axis Title\n- `opts.color_tick_y2` : Color of the Y2 axis Ticks\n- `opts.side` : side on which the Y2 tick has to be placed. Has values 'right' or `left`.\n- `opts.showlegend` : Display legends (boolean values)\n- `opts.top` : Set the top margin of the plot\n- `opts.bottom` : Set the bottom margin of the plot\n- `opts.right` : Set the right margin of the plot\n- `opts.left` : Set the left margin of the plot \n\nThis is the image of the output: \n

\n\n\n### Network Graph\n\nThis function draws a graph, in which the nodes and edges are taken from a 2-D matrix of size [,2] where each row contains a source and destination node value. The numeric value used to define nodes should be strictly between (0 to n-1), where n is the number of nodes. \n \nThere are two optional arguments :\n- `edgeLabels` : list of custom edge labels. If not provided each edge gets a label, \"source-destination\", eg \"1-2\", size should be equal to size of input \"edges\". Optional.\n- `nodeLabels` : list of custom node labels. If not provided each node gets a label same as the numeric value defined in the \"edges\". size should be equal to number of nodes present. Optional.\n\nThe following opts are supported:\n- `opts.height` : Height of the plot. Default : 500\n- `opts.width` : Width of the plot. Default : 500\n- `opts.directed` : whether the plot should have a arrow or not. Default : false\n- `opts.showVertexLabels` : Whether to show vertex labels. Default : true\n- `opts.showEdgeLabels` : Whether to show edge labels. Default : false\n- `opts.scheme` : Whether all nodes shoud have \"same\" color or \"different\". Default : \"same\"\n\n### Customizing plots\n\nThe plotting functions take an optional `opts` table as input that can be used to change (generic or plot-specific) properties of the plots. \n\nAll input arguments are specified in a single table; the input arguments are matches based on the keys they have in the input table.\n\nThe following `opts` are generic in the sense that they are the same for all visualizations (except `plot.image`, `plot.text`, `plot.video`, and `plot.audio`):\n\n- `opts.title` : figure title\n- `opts.width` : figure width\n- `opts.height` : figure height\n- `opts.showlegend` : show legend (`true` or `false`)\n- `opts.xtype` : type of x-axis (`'linear'` or `'log'`)\n- `opts.xlabel` : label of x-axis\n- `opts.xtick` : show ticks on x-axis (`boolean`)\n- `opts.xtickmin` : first tick on x-axis (`number`)\n- `opts.xtickmax` : last tick on x-axis (`number`)\n- `opts.xtickvals` : locations of ticks on x-axis (`table` of `number`s)\n- `opts.xticklabels` : ticks labels on x-axis (`table` of `string`s)\n- `opts.xtickstep` : distances between ticks on x-axis (`number`)\n- `opts.xtickfont` : font for x-axis labels (dict of [font information](https://plot.ly/javascript/reference/#layout-font))\n- `opts.ytype` : type of y-axis (`'linear'` or `'log'`)\n- `opts.ylabel` : label of y-axis\n- `opts.ytick` : show ticks on y-axis (`boolean`)\n- `opts.ytickmin` : first tick on y-axis (`number`)\n- `opts.ytickmax` : last tick on y-axis (`number`)\n- `opts.ytickvals` : locations of ticks on y-axis (`table` of `number`s)\n- `opts.yticklabels` : ticks labels on y-axis (`table` of `string`s)\n- `opts.ytickstep` : distances between ticks on y-axis (`number`)\n- `opts.ytickfont` : font for y-axis labels (dict of [font information](https://plot.ly/javascript/reference/#layout-font))\n- `opts.marginleft` : left margin (in pixels)\n- `opts.marginright` : right margin (in pixels)\n- `opts.margintop` : top margin (in pixels)\n- `opts.marginbottom`: bottom margin (in pixels)\n\n`opts` are passed as dictionary in python scripts.You can pass `opts` like:\n\n opts=dict(title=\"my title\", xlabel=\"x axis\",ylabel=\"y axis\")\n\nOR\n\n opts={\"title\":\"my title\", \"xlabel\":\"x axis\",\"ylabel\":\"y axis\"}\n \nThe other options are visualization-specific, and are described in the\ndocumentation of the functions.\n\n### Others\n\n#### vis.close\n\nThis function closes a specific window. It takes input window id `win` and environment id `eid`. Use `win` as `None` to close all windows in an environment.\n\n#### vis.delete_env\n\nThis function deletes a specified env entirely. It takes env id `eid` as input.\n\n> **Note**: `delete_env` is deletes all data for an environment and is IRREVERSIBLE. Do not use unless you absolutely want to remove an environment.\n\n\n#### vis.fork_env\n\nThis function forks an environment, similiar to the UI feature.\n\nArguments:\n- `prev_eid`: Environment ID that we want to fork.\n- `eid`: New Environment ID that will be created with the fork.\n\n> **Note**: `fork_env` an exception will occur if an env that doesn't exist is forked.\n\n#### vis.win_exists\n\nThis function returns a bool indicating whether or not a window `win` exists on the server already. Returns None if something went wrong.\n\nOptional arguments:\n- `env`: Environment to search for the window in. Default is `None`.\n\n#### vis.get_env_list\n\nThis function returns a list of all of the environments on the server at the time of calling. It takes no arguments.\n\n#### vis.win_hash\n\nThis function returns md5 hash of the contents of a window `win` if it exists on the server. Returns None otherwise.\n\nOptional arguments:\n- `env` : Environment to search for the window in. Default is `None`.\n\n\n#### vis.get_window_data\nThis function returns the window data for the given window. Returns data for all windows in an env if win is None.\n\nArguments:\n- `env`: Environment to search for the window in.\n- `win`: Window to return data for. Set to `None` to retrieve all the windows in an environment.\n\n#### vis.check_connection\n\nThis function returns a bool indicating whether or not the server is connected. It accepts an optional argument `timeout_seconds` for a number of seconds to wait for the server to come up.\n\n#### vis.replay_log\nThis function takes the contents of a visdom log and replays them to the current server to restore a state or handle any missing entries.\n\nArguments:\n- `log_filename`: log file to replay the contents of.\n\n## Customizing Visdom\nThe user config directory for visdom is\n- `~/.config/visdom` for Linux\n- `~/Library/Preferences/visdom` for OSX\n- `%APPDATA%/visdom` for Windows\n\nBy placing a `style.css` in you user config directory, visdom will serve the customized css file along with the default style-file.\nIn addition, it is also possible to create a project-specific file; just place the file `style.css` in your `env_path`.\n\n## License\nvisdom is Apache 2.0 licensed, as found in the LICENSE file.\n\n## Note on Lua Torch Support\nSupport for Lua Torch was deprecated following `v0.1.8.4`. If you'd like to use torch support, you'll need to download that release. You can follow the usage instructions there, but it is no longer officially supported.\n\n## Contributing\nSee guidelines for contributing [here.](./CONTRIBUTING.md)\n\n## Acknowledgments\nVisdom was inspired by tools like [display](https://github.com/szym/display) and relies on [Plotly](https://plot.ly/) as a plotting front-end.\n","description_content_type":"text/markdown","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/facebookresearch/visdom","keywords":"","license":"Apache-2.0","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"visdom","package_url":"https://pypi.org/project/visdom/","platform":null,"project_url":"https://pypi.org/project/visdom/","project_urls":{"Homepage":"https://github.com/facebookresearch/visdom"},"provides_extra":null,"release_url":"https://pypi.org/project/visdom/0.2.4/","requires_dist":null,"requires_python":"","summary":"A tool for visualizing live, rich data for Torch and Numpy","version":"0.2.4","yanked":false,"yanked_reason":null}

\n \n \n Creating, organizing & sharing visualizations of live, rich data. Supports Python.\n

\n
\n $\"Logo\"/$

\n Creating, organizing & sharing visualizations of live, rich data. Supports Python.\n

Package search

visdom

project_urls

Dependencies

All package metadata

Releases