Migration utility options

To migrate object feature vectors to another neural network model, you need the sf-api-migrate utility. You can find the detailed information on the usage in this section.

To get the information about command line parameters for sf-api-migrate utility, run the following command:

docker run --rm -ti --entrypoint "/sf-api-migrate" docker.int.ntl/ntech/universe/sf-api:ffserver-11.240325 --help

Configuration options:

Command line flags

Type

Description

-config

string

Path to config file.

-config-template

Output config template and exit

-extraction-api-extraction-api

string

Extraction API address legacy argument – please switch to url.

-extraction-api-keepalive

duration

keep-alive connection timeout (default 24h0m0s).

-extraction-api-max-idle-conns-per-host

int

max idle keep-alive connections per host (default 20).

-extraction-api-timeouts-connect

duration

extraction-api-timeouts-connect (default 5s).

-extraction-api-timeouts-idle-connection

duration

extraction-api-timeouts-idle-connection (default 10s).

-extraction-api-timeouts-overall

duration

extraction-api-timeouts-overall (default 35s).

-extraction-api-timeouts-response-header

duration

extraction-api-timeouts-response-header (default 30s).

-extraction-api-trace

Enable HTTP tracing (extremely verbose, slows everything down considerably).

-extraction-api-url

string

Extraction API address (default http://127.0.0.1:18666).

-extraction-batch-size

int

Extraction api batch size(8 is recommended) (default 8).

-help

Print help information

-normalized-storage-enabled

Enables normalize saving (default true).

-normalized-storage-s3-access-key

string

Access key for the object storage.

-normalized-storage-s3-bucket-name

string

S3 storage bucket name.

-normalized-storage-s3-endpoint

string

S3 compatible object storage endpoint.

-normalized-storage-s3-operation-timeout

int

Storage operations (Get,Put,Delete) timeout in seconds (default 30).

-normalized-storage-s3-public-url

string

Storage public url.

-normalized-storage-s3-region

string

Storage region.

-normalized-storage-s3-secret-access-key

string

Secret key for the object storage.

-normalized-storage-s3-secure

If ‘true’ API requests will be secure (HTTPS), and insecure (HTTP) otherwise (default true).

-normalized-storage-webdav-keepalive

duration

keep-alive connection timeout (default 24h0m0s).

-normalized-storage-webdav-max-idle-conns-per-host

int

max idle keep-alive connections per host (default 20).

-normalized-storage-webdav-timeouts-connect

duration

normalized-storage-webdav-timeouts-connect (default 5s).

-normalized-storage-webdav-timeouts-idle-connection

duration

normalized-storage-webdav-timeouts-idle-connection (default 10s).

-normalized-storage-webdav-timeouts-overall

duration

normalized-storage-webdav-timeouts-overall (default 35s).

-normalized-storage-webdav-timeouts-response-header

duration

normalized-storage-webdav-timeouts-response-header (default 30s).

-normalized-storage-webdav-trace

Enable HTTP tracing (extremely verbose, slows everything down considerably).

-normalized-storage-webdav-upload-url

string

webdav storage for normalized, disable normalized if empty string (default http://127.0.0.1:3333/uploads/).

-normalized_storage

string

Normalized storage type: webdav, s3 (default webdav).

-objects

value

Supported object types (default face, body, car).

-objects-limit

int

Get objects_limit objects from (default 1000).

-storage-api-from-cooldown

duration

Cooldown timeout after communication error (default 2s).

-storage-api-from-galleries-read-slave-first

Prefer slaves over master for get/list galleries requests.

-storage-api-from-keepalive

duration

keep-alive connection timeout (default 24h0m0s).

-storage-api-from-max-idle-conns-per-host

int

max idle keep-alive connections per host (default 20).

-storage-api-from-max-slave-attempts

int

Give up after trying to read from max_slave_attempts slaves (default 2).

-storage-api-from-read-slave-first

Prefer slaves over master for requests.

-storage-api-from-read-slave-only

Ignore master on read requests. If true: ReadSlaveFirst will be ignored.

-storage-api-from-timeouts-connect

duration

storage-api-from-timeouts-connect (default 5s).

-storage-api-from-timeouts-idle-connection

duration

storage-api-from-timeouts-idle-connection (default 10s).

-storage-api-from-timeouts-overall

duration

storage-api-from-timeouts-overall (default 35s).

-storage-api-from-timeouts-response-header

duration

storage-api-from-timeouts-response-header (default 30s).

-storage-api-from-trace

Enable HTTP tracing (extremely verbose, slows everything down considerably).

-storage-api-to-cooldown

duration

Cooldown timeout after communication error (default 2s).

-storage-api-to-galleries-read-slave-first

Prefer slaves over master for get/list galleries requests.

-storage-api-to-keepalive

duration

keep-alive connection timeout (default 24h0m0s).

-storage-api-to-max-idle-conns-per-host

int

max idle keep-alive connections per host (default 20).

-storage-api-to-max-slave-attempts

int

Give up after trying to read from max_slave_attempts slaves (default 2).

-storage-api-to-read-slave-first

Prefer slaves over master for requests.

-storage-api-to-read-slave-only

Ignore master on read requests. If true: ReadSlaveFirst will be ignored.

-storage-api-to-timeouts-connect

duration

storage-api-to-timeouts-connect (default 5s).

-storage-api-to-timeouts-idle-connection

duration

storage-api-to-timeouts-idle-connection (default 10s).

-storage-api-to-timeouts-overall

duration

storage-api-to-timeouts-overall (default 35s).

-storage-api-to-timeouts-response-header

duration

storage-api-to-timeouts-response-header (default 30s).

-storage-api-to-trace

Enable HTTP tracing (extremely verbose, slows everything down considerably).

-workers-num

int

Extract and save concurrent workers number(100+ is ok) (default 100).

The format of environment variable for flag -my-flag is CFG_MY_FLAG.

Priority:

  1. Defaults from source code (lowest priority).

  2. Configuration file.

  3. Environment variables.

  4. Command line.