Skip to content

Commit

Permalink
more info in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JosuaKrause committed Jul 27, 2023
1 parent 69e38c0 commit 8f69a26
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Visualization for Various Similarity Functions

The visualization can be found [here](https://josuakrause.github.io/searchspace/).
[![The euclidean distance forming voronoi regions.](media/thumbnail.png)](https://josuakrause.github.io/searchspace/)

This visualization shows distances of various similarity functions in a 2D vector space.
You can add and remove points interactively. Boundaries of closest neighbor regions are shown in red.
Read more about it on [Medium](https://medium.com/@josua.krause/aff7667da6cc?source=friends_link&sk=1a7e02ec41f35b625fe5eb08da8623cb).

The live version can be found [here](https://josuakrause.github.io/searchspace/).

## Running Locally

The whole repo can be served as is. There is no build step.
For convenience the `make run-web` command exists to start a local file server.

## Converting Videos

After recording a video using the `Record` button it is saved in the `webm` format.
If a `gif` is needed, the `make convert INPUT=~/Downloads/video.webm` converts the
`webm` video and places the `gif` version into the same folder. `ffmpeg` is required.

## Contributing

If you encounter any bugs or problems, feel free to file an [issue](https://github.com/JosuaKrause/searchspace/issues).

0 comments on commit 8f69a26

Please sign in to comment.