01 Installation

01 Installation#

Installation#

You can get a LightlyEdge version from your contact at Lightly. You will receive a package with:

  • LightlyEdge Python SDK: A folder named lightly_edge_sdk_py with a number of .whl files.

  • ML models: A TAR archive of the form lightly_model_{version}.tar.

Install the lightly_edge_sdk package with PIP:

pip install lightly_edge_sdk --pre --find-links path/to/lightly_edge_sdk_py

Note

--find-links will automatically find the right wheel file for your system and Python version. If the command fails, make sure the path after --find-links points to the folder with .whl files.

For simplicity, the documentation examples assume the model is named lightly_model.tar. Please replace these occurences with your model filename.

Test Your Installation#

Run python from the command line in the folder with lightly_model.tar and type:

>>> from lightly_edge_sdk import LightlyEdge
>>> LightlyEdge("lightly_model.tar")

If you see a response similar to <builtins.LightlyEdge object at 0x104be5fe0>, congratulations, LightlyEdge is successfully installed!

Note

If you get an IO error, make sure the path to the embedding model is set correctly.

Optional: GPU Support#

Please install the following to use LightlyEdge with Nvidia GPUs:

  • Nvidia CUDA 12

  • Nvidia cuDNN 9

If GPU is not avalable LightlyEdge will default to a CPU.