|ReadTheDocs Badge| |License Badge| |PyPi Badge| |Black Badge|
ParaDime is a modular framework for specifying and training parametric dimensionality reduction (DR) models. These models allow you to add new data points to existing low-dimensional representations of high-dimensional data. ParaDime DR models are constructed from simple building blocks (such as the relations between data points), so that experimentation with novel DR techniques becomes easy.
ParaDime is available via PyPi through:
.. code-block:: text
pip install paradimeParaDime requires Numpy <https://numpy.org/>, SciPy <https://scipy.org/>, scikit-learn <https://scikit-learn.org/>, and PyNNDescent <https://github.com/lmcinnes/pynndescent> (see |req text|_ file), all of which are installed auomatically when installing ParaDime.
ParaDime also requires PyTorch <https://pytorch.org/>, which must be installed separately. If you want to train ParaDime routines on the GPU, make sure to install CUDA along with the correct cudatoolkit version. See the PyTorch docs <https://pytorch.org/get-started/locally/> for detailed installation info.
If you want to use ParaDime's plotting utilities, Matplotlib <https://matplotlib.org/>_ has to be installed additionally.
.. |req text| replace:: requirements.txt
.. _req text: https://github.com/einbandi/paradime/blob/master/requirements.txt
For a simple example with one of the predefined ParaDime routines, see Simple Usage <https://paradime.readthedocs.io/en/latest/simple_usage.html>_ in the documentation.
More detailed information about how to set up cusom routines can be found in Building Blocks of a ParaDime Routine <https://paradime.readthedocs.io/en/latest/building_blocks.html>_.
For additional examples of varying complexity, see Examples <https://paradime.readthedocs.io/en/latest/examples.html>_.
.. [1] Van Der Maaten, L., Hinton, G. “Visualizing data using t-SNE” <http://www.jmlr.org/papers/volume9/vandermaaten08a/vandermaaten08a.pdf>__, Journal of Machine Learning Research (2008).
.. [2] LeCun, Y., Cortes, C., Burges, C.J.C. “The MNIST database of handwritten digits” <http://yann.lecun.com/exdb/mnist/>__ (1998).
.. |ReadTheDocs Badge| image:: https://readthedocs.org/projects/paradime/badge/?version=latest&style=flat-square :target: https://paradime.readthedocs.io/en/latest/index.html :alt: Documentation Status
.. |License Badge| image:: https://img.shields.io/github/license/einbandi/paradime?style=flat-square :target: https://mit-license.org/ :alt: License
.. |PyPi Badge| image:: https://img.shields.io/pypi/v/paradime?style=flat-square :target: https://pypi.org/project/paradime/ :alt: PyPi Version
.. |Black Badge| image:: https://img.shields.io/badge/code%20style-black-black?&style=flat-square :target: https://github.com/psf/black :alt: Code Style