Installation

tprofiler is currently hosted on PyPI. It required python >= 3.8.

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

pip install tprofiler

You can also install with the newest version through GitHub:

pip install -U git+https://github.com/hansbug/tprofiler@main

You can check your installation by the following python script:

from tprofiler.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.

tprofiler 0.0.1
Developed and maintained by hansbug
Torch Profiler (Based on Verl Project)

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