From d43ccc4f05403d7e6c33c5bf0c0cc6934cd23a4d Mon Sep 17 00:00:00 2001 From: Yannick Assogba Date: Mon, 16 Mar 2020 11:53:15 -0400 Subject: [PATCH 1/2] update readme --- tfjs-vis/README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/tfjs-vis/README.md b/tfjs-vis/README.md index 223684da48c..1ce663c565b 100644 --- a/tfjs-vis/README.md +++ b/tfjs-vis/README.md @@ -7,11 +7,30 @@ It's main features are: * A set of visualizations useful for visualizing model behaviour * A set of high level functions for visualizing objects specific to TensorFlow.js -* A way to organize visualizations of model behaviour that won't interfere with your web application +* A way to organize visualizations (the visor) of model behaviour that won't interfere with your web application The library also aims to be flexible and make it easy for you to incorporate custom visualizations using tools of your choosing, such as d3, Chart.js or plotly.js. +## Example Screenshots + +### Training Metrics + +![Training metrics (loss and accuracy) for a model](https://storage.googleapis.com/tfjs-assets/tfjs-vis/tfjs-vis-training.png) + +### Model Evauation + +![Dataset accuracy metrics in a table and confusion matrix visualization](https://storage.googleapis.com/tfjs-assets/tfjs-vis/tfjs-vis-evaluation.png) + +### Model Internals + +![Model summary table and histogram of conv2d weights](https://storage.googleapis.com/tfjs-assets/tfjs-vis/tfjs-vis-model-details.png) + +### Activations and custom visualizations + +![visualization of dataset activations in a conv2d layer and a dense layer](https://storage.googleapis.com/tfjs-assets/tfjs-vis/tfjs-vis-model-internals.png) + + ## Demos - [Visualizing Training with tfjs-vis](https://storage.googleapis.com/tfjs-vis/mnist/dist/index.html) @@ -89,10 +108,6 @@ const surface = tfvis.visor().surface({ name: 'Barchart', tab: 'Charts' }); tfvis.render.barchart(surface, data, {}); ``` -This should show something like the following - -![visor screenshot with barchart](./docs/visor-usage.png) - ## Issues Found a bug or have a feature request? Please file an [issue](https://github.com/tensorflow/tfjs/issues/new) on the main [TensorFlow.js repository](https://github.com/tensorflow/tfjs/issues) From fc033cfa25ed3c90d76a225fa6c4eb4eaf4d263a Mon Sep 17 00:00:00 2001 From: Yannick Assogba Date: Mon, 16 Mar 2020 11:55:18 -0400 Subject: [PATCH 2/2] save --- tfjs-vis/README.md | 45 +++++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/tfjs-vis/README.md b/tfjs-vis/README.md index 1ce663c565b..726de0589ff 100644 --- a/tfjs-vis/README.md +++ b/tfjs-vis/README.md @@ -59,6 +59,29 @@ below. ``` +## API + +See https://js.tensorflow.org/api_vis/latest/ for interactive API documentation. + +## Sample Usage + +```js +const data = [ + { index: 0, value: 50 }, + { index: 1, value: 100 }, + { index: 2, value: 150 }, +]; + +// Get a surface +const surface = tfvis.visor().surface({ name: 'Barchart', tab: 'Charts' }); + +// Render a barchart on that surface +tfvis.render.barchart(surface, data, {}); +``` + +## Issues + +Found a bug or have a feature request? Please file an [issue](https://github.com/tensorflow/tfjs/issues/new) on the main [TensorFlow.js repository](https://github.com/tensorflow/tfjs/issues) ## Building from source @@ -92,26 +115,4 @@ npm run build This should produce a `tfjs-vis.umd.min.js` file in the `dist` folder that you can use. -## Sample Usage - -```js -const data = [ - { index: 0, value: 50 }, - { index: 1, value: 100 }, - { index: 2, value: 150 }, -]; - -// Get a surface -const surface = tfvis.visor().surface({ name: 'Barchart', tab: 'Charts' }); -// Render a barchart on that surface -tfvis.render.barchart(surface, data, {}); -``` - -## Issues - -Found a bug or have a feature request? Please file an [issue](https://github.com/tensorflow/tfjs/issues/new) on the main [TensorFlow.js repository](https://github.com/tensorflow/tfjs/issues) - -## API - -See https://js.tensorflow.org/api_vis/latest/ for interactive API documentation.