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.19.2.2021.12.8.3.47.19.144768.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7c04e7fbab216f0df3109cc4dce46d174c5aef0b4ed170799f5b72ed0e34a92 |
|
MD5 | edb3b084e460cfd73969e2f113aded9f |
|
BLAKE2b-256 | 671c4a4b9f680330809fc4b6f531b0ab985c3b11b3b9a4e1833361b94c4fce01 |
Hashes for RelevanceAI_dev-0.19.2.2021.12.8.3.47.19.144768-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40de6d1dfd50600e7a5ac208157d1afca874f7307df590022e4f8e79cfea1687 |
|
MD5 | cc65302f903cfe96361b414d06efc3a1 |
|
BLAKE2b-256 | 0b012004826fc6b7896ea61f16339d8ddaa2ed0ebaaef9e251ea605b100b22ee |