Installation Guide
GPU Version requires NVidia CUDA backend, you need to install
nvidia-docker
first.Run docker image
1. Set Environment Variable
Run these commands in your Terminal.
YOUR_CLOUD_ACCESS_KEY
is your access key from Visionaire Cloud.YOUR_CLOUD_SECRET_KEY
is your secret key from Visionaire Cloud.NFFS-FR
should be contained in your deployment key details.
2. Create User-Defined Docker Network & Volumes
Create a user-defined bridge network:
Create docker volumes for postgresdb:
3. Run Postgres Container
Create Postgre Container
Init new additional DB
4. Run Visionaire Docker Snapshot (fremis-n:v2.8.5)
(fremis-n:v2.8.5)
Visionaire Docker Snapshot started from version
v1.0.0
no longer requires cloud username and password.Start from installation will be done using the Postgre database to ensure data persistence. Database migration is required once.
If you have enrollments using
fremis-n
version below 1.4.0 and upgrading to version 1.4.0, you need to re-enroll the enrollments.
Select one of installer below:
Run FremisN Services (GPU Version) - Faster latency & higher QPS / throughput
Get a lower latency & higher QPS / throughput by using GPU version. However, GPU version requires you to set designated enrollment counts for every keyspace at a config file.
Please create a folder --which later we call it as
<HOST FREMIS-N CONFIG FOLDER>
--, then create a file named asconfig.yml
inside<HOST FREMIS-N CONFIG FOLDER>
with content as follows:
the command to run FRemis-N GPU
Notes:
If you want to change the enrollments count whereas FRemis-N GPU is already running, please shut FRemis-N down > change the enrollments count value in
config.yml
> start againSingle FRemis-N container/instance doesn't support multiple GPU yet. Hence, when you run with
--gpus all
while the computer utilizes more than 1 GPU, likely it will fail
Run FremisN Services (CPU Version)
-h,--help
Print this help message and exit
--access-key
Nodeflux access key
--secret-key
Nodeflux secret key
--dk
Deployment Key
--listen-addr
Address to serve REST API
-p,--listen-port
Address to serve REST API
--listen-port-monitoring
Address port of monitoring
--server-threads
Maximum number of server's threads
--similarity-threshold
Default similarity threshold
--max-workers
Maximum number of extraction workers
--storage
Storage System. The choice are: rocksdb
and postgres
--data-path
Database Path of RocksDB, if rocksdb
selected
--db-address
Database Address of Postgres server, if postgres
selected
--db-port
Database port of Postgres server, if postgres
selected
--db-name
Database name of Postgres server, if postgres
selected
--db-username
Database username of Postgres server, if postgres
selected
--db-password
Database password of Postgres server, if postgres
selected
--partition-start
The starting number of partition set
--partition-end
The ending number of partition set
-v,--verbose
Turn on verbose logging
For getting commands help:
docker run -it --gpus device=0 nodefluxio/fremis-n:v2.8.5-gpu httpserver --help
or
docker run -it nodefluxio/fremis-n:v2.8.5-cpu httpserver --help
Last updated