docs: ✏️ add instructions

README.md

@@ -5,3 +5,20 @@ license: apache-2.0
 # Embedding Projector in TensorBoard
 
 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).
+
+To see the Embedding Projector in a local Tensorboard (assuming Ubuntu):
+
+```bash
+git clone https://huggingface.co/severo/tensorboard-embedding-projector
+cd tensorboard-embedding-projector
+python3 -m venv .venv-2.8
+source .venv-2.8/bin/activate
+pip install tensorboard tensorflow
+tensorboard --logdir logs/imdb-example
+# access http://localhost:6006/#projector
+```
+
+Notes:
+
+- 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 .`.
+- `tensorflow` must be installed, or the projector plugin will not be able to load these data.