Installation

LightTuner is currently hosted on PyPI. It required python >= 3.7.

You can simply install LightTuner from PyPI with the following command:

pip install lighttuner

You can also install with the newest version through GitHub:

pip install -U git+https://github.com/opendilab/LightTuner@main

You can check your installation by the following python script:

1
2
3
4
5
6
from lighttuner.config.meta import __TITLE__, __AUTHOR__, __VERSION__, __DESCRIPTION__

if __name__ == '__main__':
    print(__TITLE__, __VERSION__)
    print('Developed and maintained by', __AUTHOR__)
    print(__DESCRIPTION__)

The output should be like below, which means your installation is successful.

1
2
3
lighttuner 0.0.1
Developed and maintained by HansBug
A simple tool for automatic parameter tuning.

LightTuner is still under development, you can also check out the documents in stable version through https://opendilab.github.io/LightTuner/main/index.html.