Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements #1

Open
tfius opened this issue Jul 31, 2023 · 0 comments
Open

Documentation improvements #1

tfius opened this issue Jul 31, 2023 · 0 comments

Comments

@tfius
Copy link
Contributor

tfius commented Jul 31, 2023

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
@asabya asabya changed the title Documnetation improvements Documentation improvements Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant