Skip to content

Documentation improvements #1

@tfius

Description

@tfius

Uploader is a utility for inserting vectors into a key-value store in "fairOS" using a CSV file as the input. The vectors are encoded using the Gob encoding format before being stored in the key-value store.
Command-line options for specifying various parameters required for the operations:

Option Short Flag Long Flag Description Required
Verbose -l --verbose Show fairos and other debug logs No
VectorCSVPath -v --vector-csv-path Path to the embedding file Yes
EnsRPC -r --rpc-endpoint RPC endpoint for ENS authentication Yes
BeeEndpoint -b --bee-api-endpoint Bee api endpoint Yes
StampID -s --stamp Stamp id Yes
FairOSUser -u --username FDP portable username Yes
FairOSPassword -p --password Account password Yes
Pod -d --pod Pod name of the kv store Yes
KVStore -k --kv-store Kv store name Yes
KVIndexType -x Index type for the values in the kv store (Default: 2) No
graph TD
A[Start] --> B[Parse Command-line Flags]
B --> C[Initialize fairOS API]
C --> D[Login to fairOS]
D --> E[Create or Open Pod]
E --> F[Create or Open KV Store]
F --> G[Prepare KV Batch]
G --> H[Read Vectors from CSV File]
H --> I[Parse Vector and Encode]
I --> J[Insert Vector into KV Store]
J --> H
H --> L[End]
Loading

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions