Skip to content

Commit

Permalink
Merge pull request #9 from alonfnt/add-new-bib-entry
Browse files Browse the repository at this point in the history
docs: update readme to include bibtex entry
  • Loading branch information
alonfnt authored Jan 15, 2025
2 parents afa978e + 6396aea commit 7fe5be4
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TSNEx
# tsnex

**TSNEx** is a lightweight, high-performance Python library for t-Distributed Stochastic Neighbor Embedding (t-SNE) built on top of JAX. Leveraging the power of JAX, `tsnex` offers JIT compilation, automatic differentiation, and hardware acceleration support to efficiently handle high-dimensional data for visualization and clustering tasks.
**t-SNEx** is a lightweight, high-performance Python library for t-Distributed Stochastic Neighbor Embedding (t-SNE) built on top of JAX. Leveraging the power of JAX, `tsnex` offers JIT compilation, automatic differentiation, and hardware acceleration support to efficiently handle high-dimensional data for visualization and clustering tasks.

## Installation
Use the package manager [pip](https://pypi.org/project/tsnex/) to install `tsnex`.
Expand All @@ -23,6 +23,17 @@ X_embedded = tsnex.transform(X, n_components=2)
## Contributing
We welcome contributions to **TSNEx**! Whether it's adding new features, improving documentation, or reporting issues, please feel free to make a pull request and/or open an issue.

## Citation
If you use `tsnex` in your research and need to reference it, please cite it as follows:
```
@software{alonso_tsnex,
author = {Alonso, Albert},
title = {tsnex: Minimal t-distributed stochastic neighbor embedding (t-SNE) implementation in JAX},
url = {https://github.com/alonfnt/tsnex},
version = {0.0.1}
}
```

## License
TSNEx is licensed under the MIT License. See the ![LICENSE](LICENSE) file for more details.

0 comments on commit 7fe5be4

Please sign in to comment.