severo HF staff commited on
Commit
6775d43
1 Parent(s): a7e5001

docs: ✏️ add instructions

Browse files
Files changed (1) hide show
  1. README.md +17 -0
README.md CHANGED
@@ -5,3 +5,20 @@ license: apache-2.0
5
  # Embedding Projector in TensorBoard
6
 
7
  This empty model repository only contains data to test the TensorBoard Embedding Projector. The data in [./logs/imdb-example](./logs/imdb-example) have been generated using the [notebook](https://colab.research.google.com/github/tensorflow/tensorboard/blob/master/docs/tensorboard_projector_plugin.ipynb) of the official documentation page ["Visualizing Data using the Embedding Projector in TensorBoard"](https://www.tensorflow.org/tensorboard/tensorboard_projector_plugin).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
  # Embedding Projector in TensorBoard
6
 
7
  This empty model repository only contains data to test the TensorBoard Embedding Projector. The data in [./logs/imdb-example](./logs/imdb-example) have been generated using the [notebook](https://colab.research.google.com/github/tensorflow/tensorboard/blob/master/docs/tensorboard_projector_plugin.ipynb) of the official documentation page ["Visualizing Data using the Embedding Projector in TensorBoard"](https://www.tensorflow.org/tensorboard/tensorboard_projector_plugin).
8
+
9
+ To see the Embedding Projector in a local Tensorboard (assuming Ubuntu):
10
+
11
+ ```bash
12
+ git clone https://huggingface.co/severo/tensorboard-embedding-projector
13
+ cd tensorboard-embedding-projector
14
+ python3 -m venv .venv-2.8
15
+ source .venv-2.8/bin/activate
16
+ pip install tensorboard tensorflow
17
+ tensorboard --logdir logs/imdb-example
18
+ # access http://localhost:6006/#projector
19
+ ```
20
+
21
+ Notes:
22
+
23
+ - to see the projector in a local tensorboard instance, you have to point the `--logdir` argument specifically to the `logs/imdb-example` directory, as tensorboard does not succeed in looking for projector data recursively as it does for scalar data with `--logdir .`.
24
+ - `tensorflow` must be installed, or the projector plugin will not be able to load these data.