Shortcuts

Code Coverage

To check branch stability run the sanity suite as follows

  • Install dependencies (if not already installed) For CPU:

    python ts_scripts/install_dependencies.py --environment=dev
    

    For GPU

    • Install dependencies (if not already installed)

    python ts_scripts/install_dependencies.py --environment=dev --cuda=cu121
    

    Supported cuda versions as cu121, cu118, cu117, cu116, cu113, cu111, cu102, cu101, cu92

  • Execute sanity suite

    python ./torchserve_sanity.py
    

To run frontend build suite run following command

frontend/gradlew -p frontend clean build

TorchServe frontend build suite consists of :

  • checkstyle

  • findbugs

  • PMD

  • UT

The reports are generated at following path : frontend/server/build/reports

To run backend pytest suite run following command

python -m pytest --cov-report html:htmlcov --cov=ts/ ts/tests/unit_tests/

The reports are generated at following path : htmlcov/

To run python linting on ts package run following command

pylint -rn --rcfile=./ts/tests/pylintrc ts/.

To run pytest suite on model-archiver run following command

cd model-archiver
python -m pytest --cov-report html:htmlcov_ut --cov=model_archiver/ model_archiver/tests/unit_tests/

The reports are generated at following path : model-archiver/htmlcov_ut/

To run IT suite on model-archiver run following command

cd model-archiver
pip install .
python -m pytest --cov-report html:htmlcov_it --cov=model_archiver/ model_archiver/tests/integ_tests/

The reports are generated at following path : model-archiver/htmlcov_it/

Note: All the above commands needs to be excuted from serve home

Docs

Access comprehensive developer documentation for PyTorch

View Docs

Tutorials

Get in-depth tutorials for beginners and advanced developers

View Tutorials

Resources

Find development resources and get your questions answered

View Resources