Skip to content

Model Complexity Badge Integration

Set up the Complexity Badge

Warning

Please note the following limitations:

  • A file called model-complexity-badge.svg has to exist in the repository. We provide a Gitlab CI template and a Github action to generate the file. Find more information below.
  • Only project leads can set up the model complexity badge. In addition, one needs access to the Git repository of the model.
  1. To set up the model complexity badge, you need to add the Git API URL to your Git instance. More information here.

  2. Link a Git repository to the model, for which you'd like to see the model complexity badge.

    Info

    If the Github repository is public, no token is required for the model complexity badge. For private Github repositories and for Gitlab repositories the model complexity badge integration uses the credentials, which are assigned during linking the Git repository.

    • Gitlab: Limit the scope of the used token, only scope read_api is required.
    • Github: If you are using a fine-grained personal access token, add the repository permission for the scope "content" with access Read-only.

  3. Follow the CI template instructions

    to add the complexity badge pipeline to the linked repository.

View the Model Complexity Badge

The model complexity badge is visible in the model overview in the project details:

Model complexity badge