# visualdl

> A platform to visualize the deep learning process and result.

Latest version **2.0.0-beta.26** (published 2020-03-26) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install visualdl
pnpm add visualdl
yarn add visualdl
bun add visualdl
```

Provides the command `visualdl`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0-beta.26 |
| Published | 2020-03-26 |
| First published | 2020-03-09 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 37 |
| Unpacked size | 52.7 MB |
| Known vulnerabilities | 0 (+21 in 7 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4878 |
| Author | PeterPanZH |
| Maintainers | pzh_667 |
| Keywords | visualdl, paddlepaddle, visualization, deep learning |

## Links

- npm: https://www.npmjs.com/package/visualdl
- Repository: https://github.com/PaddlePaddle/VisualDL
- Issues: https://github.com/PaddlePaddle/VisualDL/issues
- npm.io page: https://npm.io/package/visualdl

## Dependencies (37)

- [ora](https://npm.io/package/ora.md) 4.0.3
- [pm2](https://npm.io/package/pm2.md) 4.2.3
- [swr](https://npm.io/package/swr.md) 0.1.18
- [url](https://npm.io/package/url.md) 0.11.0
- [next](https://npm.io/package/next.md) 9.3.1
- [open](https://npm.io/package/open.md) 7.0.3
- [react](https://npm.io/package/react.md) 16.13.1
- [yargs](https://npm.io/package/yargs.md) 15.3.1
- [lodash](https://npm.io/package/lodash.md) 4.17.15
- [moment](https://npm.io/package/moment.md) 2.24.0
- [echarts](https://npm.io/package/echarts.md) 4.7.0
- [express](https://npm.io/package/express.md) 4.17.1
- [i18next](https://npm.io/package/i18next.md) 19.3.3
- [dagre-d3](https://npm.io/package/dagre-d3.md) 0.6.4
- [polished](https://npm.io/package/polished.md) 3.5.1
- [react-is](https://npm.io/package/react-is.md) 16.13.1
- [nprogress](https://npm.io/package/nprogress.md) 0.2.0
- [react-dom](https://npm.io/package/react-dom.md) 16.13.1
- [echarts-gl](https://npm.io/package/echarts-gl.md) 1.1.1
- [path-match](https://npm.io/package/path-match.md) 1.2.4
- [prop-types](https://npm.io/package/prop-types.md) 15.7.2
- [detect-node](https://npm.io/package/detect-node.md) 2.0.4
- [bignumber.js](https://npm.io/package/bignumber.js.md) 9.0.0
- [query-string](https://npm.io/package/query-string.md) 6.11.1
- [react-i18next](https://npm.io/package/react-i18next.md) 11.3.4
- [react-spinners](https://npm.io/package/react-spinners.md) 0.8.1
- [save-svg-as-png](https://npm.io/package/save-svg-as-png.md) 1.4.17
- [react-input-range](https://npm.io/package/react-input-range.md) 1.3.0
- [styled-components](https://npm.io/package/styled-components.md) 5.0.1
- [isomorphic-unfetch](https://npm.io/package/isomorphic-unfetch.md) 3.0.0
- [react-hooks-worker](https://npm.io/package/react-hooks-worker.md) 0.9.0
- [i18next-xhr-backend](https://npm.io/package/i18next-xhr-backend.md) 3.2.2
- [http-proxy-middleware](https://npm.io/package/http-proxy-middleware.md) 1.0.3
- [hoist-non-react-statics](https://npm.io/package/hoist-non-react-statics.md) 3.3.2
- [i18next-node-fs-backend](https://npm.io/package/i18next-node-fs-backend.md) 2.1.3
- [i18next-express-middleware](https://npm.io/package/i18next-express-middleware.md) 1.9.1
- [i18next-browser-languagedetector](https://npm.io/package/i18next-browser-languagedetector.md) 4.0.2

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 2.0.0-beta.26 (latest) — 2020-03-26
- 2.0.0-beta.25 — 2020-03-25
- 2.0.0-beta.24 — 2020-03-22
- 2.0.0-beta.23 — 2020-03-20
- 2.0.0-beta.22 — 2020-03-20
- 2.0.0-beta.21 — 2020-03-20
- 2.0.0-beta.20 — 2020-03-18
- 2.0.0-beta.19 — 2020-03-13
- 2.0.0-beta.18 — 2020-03-11
- 2.0.0-beta.17 — 2020-03-11
- 2.0.0-beta.16 — 2020-03-11
- 2.0.0-beta.15 — 2020-03-10
- 2.0.0-beta.14 — 2020-03-10
- 2.0.0-beta.13 — 2020-03-10
- 2.0.0-beta.12 — 2020-03-10
- … 11 more at https://npm.io/package/visualdl/versions

## README

<p align="center">
    <a href="https://github.com/PaddlePaddle/VisualDL"><img align="center" style="width:480px" width="480" src="https://raw.githubusercontent.com/PaddlePaddle/VisualDL/develop/frontend/public/images/logo-visualdl.svg?sanitize=true" alt="VisualDL" /></a>
</p>
<br />

<p align="center">
    <a href="https://www.npmjs.com/package/visualdl"><img src="https://img.shields.io/npm/v/visualdl?style=flat-square" alt="NPM Version" /></a>
    <a href="https://travis-ci.org/PaddlePaddle/VisualDL"><img src="https://img.shields.io/travis/PaddlePaddle/VisualDL?style=flat-square" alt="Build Status" /></a>
    <a href="https://github.com/PaddlePaddle/VisualDL"><img src="https://img.shields.io/github/languages/top/PaddlePaddle/VisualDL?style=flat-square" alt="GitHub top language" /></a>
    <a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square" alt="code style: prettier" /></a>
    <a href="https://github.com/PaddlePaddle/VisualDL/blob/develop/LICENSE"><img src="https://img.shields.io/github/license/PaddlePaddle/VisualDL?style=flat-square" alt="License" /></a>
    <a href="https://github.com/PaddlePaddle/VisualDL/issues"><img src="https://img.shields.io/github/issues/PaddlePaddle/VisualDL?style=flat-square" alt="GitHub issues" /></a>
    <a href="https://github.com/PaddlePaddle/VisualDL/graphs/contributors"><img src="https://img.shields.io/github/contributors/PaddlePaddle/VisualDL?style=flat-square" alt="GitHub Contributors" /></a>
    <a href="https://github.com/PaddlePaddle/VisualDL/stargazers"><img src="https://img.shields.io/github/stars/PaddlePaddle/VisualDL?style=social" alt="GitHub stars" /></a>
</p>

# VisualDL FrontEnd

English | [简体中文](https://github.com/PaddlePaddle/VisualDL/blob/develop/frontend/README_cn.md)

**🚧UNDER DEVELOPMENT🚧**

**🚧SOME FEATURE MAY NOT WORK PROPERLY🚧**

**🚧PULL REQUESTS WELCOMED🚧**

## Usage

> nodejs ≥ 10 and npm ≥ 6 are required.

```bash
npm install -g visualdl
# or
yarn global add visualdl
```

Then you can start visualdl server by

```bash
visualdl start --backend="http://127.0.0.1:8040"
```

To stop visualdl server, just type

```bash
visualdl stop
```

For more usage infomation, please type

```bash
visualdl -h
```

## Development

First, install all dependencies:

```bash
npm install
# or
yarn
```

Then you can start the development server:

```bash
yarn dev
```

Now open [http://localhost:8999](http://localhost:8999) with your browser.

You can change the port with `PORT` environment variable:

```bash
PORT=3000 yarn dev
```

### WebAssembly

WebAssembly is **DISABLED** by default under development environment.

If you want to develop wasm features, you must have [Rust](https://www.rust-lang.org/) and [Cargo](https://doc.rust-lang.org/cargo/) installed.

Using [rustup](https://rustup.rs/) to install them.

Then install [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/) to build rust code to wasm binaries.

When environment is ready, start the development server with following command:

```bash
yarn dev:wasm
```

## Build & Deploy

```bash
./scripts/build.sh

yarn start

# we are working on deployment now, please wait
```

### Browser Compatibility

VisualDL supports the latest version of [Google Chrome](https://www.google.com/chrome/) and [Mozilla Firefox](https://www.mozilla.org/). [Microsoft Edge](https://www.microsoft.com/edge) and [Apple Safari](https://www.apple.com/safari/) may work too but are not tested.

## Learn More

This project is based on following projects:

- [Next.js](https://nextjs.org/)
- [React](https://reactjs.org/)
- [ECharts](https://echarts.apache.org/)
- [wasm-pack](https://rustwasm.github.io/wasm-pack/)

## Author
<table><tr><td align="center"><a href="https://github.com/PeterPanZH"><img src="https://avatars0.githubusercontent.com/u/3366499?s=460&v=4" width="120px;" alt="PeterPanZH"/><br /><sub><b>PeterPanZH</b></sub></a></td><td align="center"><a href="https://github.com/Niandalu"><img src="https://avatars1.githubusercontent.com/u/6406875?s=460&v=4" width="120px;" alt="Niandalu"/><br /><sub><b>Niandalu</b></sub></a></td></tr></table>

## License

[Apache-2.0](https://github.com/PaddlePaddle/VisualDL/blob/develop/LICENSE)

---
_Source: https://npm.io/package/visualdl · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
