Installation
============

HypLL was written for Python 3.10+ and PyTorch 1.11+. 

It's recommended to have a
working PyTorch installation before setting up HypLL:

* `PyTorch <https://pytorch.org/get-started/locally/>`_ installation instructions.


Install with pip
----------------

Start by setting up a Python `virtual environment <https://docs.python.org/3/library/venv.html>`_:

.. code::

   python -venv .env

Activate the virtual environment.

.. tabs::

   .. tab:: Linux and MacOs
        
      .. code::
       
         source .env/bin/activate

   .. tab:: Windows

       .. code::

         .env/Scripts/activate


Install HypLL from PyPI.

.. code::

   pip install hypll


Congratulations, you are ready to do machine learning in hyperbolic space.
Check out our :ref:`tutorials` next to get started!