Pipelines¶

PAD pipelines¶

PAD pipelines overview¶

The set of algorithms the IDLive Face relies on is grouped together in an entity called a pipeline. We constantly improve the algorithms, and each new set is bundled as a separate pipeline.

DFD pipelines¶

DFD pipelines overview¶

The set of algorithms the IDLive Face Deepfake Detection relies on is grouped together in an entity called a pipeline. We constantly improve the algorithms, and each new set is bundled as a separate pipeline.

Choosing pipeline¶

By default IDLive Face Server uses the latest available pipeline. To select another one put its name into the IDFACE_SERVER_PIPELINE environment variable:

docker run --env IDFACE_SERVER_PIPELINE=apollo ...

You can load additional pipelines by setting the IDFACE_SERVER_AVAILABLE_PIPELINES environment variable. Several pipelines should be separated with a comma:

docker run \
    --env IDFACE_SERVER_PIPELINE=apollo \
    --env IDFACE_SERVER_AVAILABLE_PIPELINES='astraea,apollo'
    ...

Note that each additional pipeline will increase the IDLive Face Server's memory usage and a startup time.

Pipeline aliases ¶

In addition to specifying pipeline names explicitly, pipeline aliases are also available and do not change from release to release. While the actual underlying pipelines might change, these aliases can simplify continuous migration by always invoking the most recent liveness pipeline for a given attack vector.

Currently available pipeline aliases:

• default-pad alias for pad-r-1
• default-dfd alias for dfd-1

Aliases can be specified instead of pipeline names on server configuration:

docker run \
    --env IDFACE_SERVER_PIPELINE=default-pad \
    --env IDFACE_SERVER_AVAILABLE_PIPELINES='default-pad,default-dfd,hestia'
    ...

And also pipeline aliases can be specified instead of pipeline names in REST API calls e.g. for /check_image:

{
  "domain": "GENERAL",
  "pipelines": [
    {
      "pipeline": "default-pad",
      "calibration": "HARDENED"
    },
    {
      "pipeline": "default-dfd",
      "calibration": "REGULAR"
    },
    {
      "pipeline": "hestia",
      "calibration": "REGULAR"
    }
  ]
}