No project description provided
Project description
RelevanceAI
For guides, tutorials on how to use this package, visit https://docs.relevance.ai/docs.
If you are looking for an SDK reference, you can find that here.
Built mainly for users looking to experiment with vectors/embeddings.
Installation
The easiest way is to install this package is to run pip install --upgrade relevanceai
.
How to use the RelevanceAI client
For example:
## To instantiate the client
from relevanceai import Client
client = Client()
Development
Getting Started
To get started with development, ensure you have pytest
and mypy
installed. These will help ensure typechecking and testing.
python -m pip install pytest mypy
Then run testing using:
Make sure to set your test credentials!
export TEST_PROJECT = xxx
export TEST_API_KEY = xxx
python -m pytest
mypy relevanceai
Config
The config contains the adjustable global settings for the SDK. For a description of all the settings, see here.
To view setting options, run the following:
client.config.options
The syntax for selecting an option is section.key. For example, to disable logging, run the following to modify logging.enable_logging:
client.config.set_option('logging.enable_logging', False)
To restore all options to their default, run the following:
client.config.reset_to_default()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for RelevanceAI-dev-0.21.1.2021.12.12.13.55.43.239978.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f1c58a79d25ce437e12b0b34a95651bb12252920ad96b72d58f3174cc8a1323 |
|
MD5 | d29c49e86c843db01af9f13eaa8b09d3 |
|
BLAKE2b-256 | f14a350f183dc2675f3da9b929358af25a1a2ec246eed1f145f7a843fee194d5 |
Hashes for RelevanceAI_dev-0.21.1.2021.12.12.13.55.43.239978-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 526556377b2c2e47ae6be5b0fb7168fc85af944a180c97b3afc695019d7f2904 |
|
MD5 | 564acabccf59ac68b16d0aa7851e29dd |
|
BLAKE2b-256 | 7f88de646a7de49e32b249e68e85b1034b9f7ce6bda52017d057ce6d5b687bda |