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.10.6.42.10.986559.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a5b622ae2cf899f8573f1e4cd01a0c1387eedff9f8ebc449ad8d61e9dffa9f0 |
|
MD5 | 563c063aafd9ae52d28722ae140aa883 |
|
BLAKE2b-256 | 4460f7e8a1e14355418d580b5a60627532cb81a642b5cef9a2120642fc4d945b |
Hashes for RelevanceAI_dev-0.21.1.2021.12.10.6.42.10.986559-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4435cecb694332b6261f5a603ebc5f7be7eb1728fd6e486828d238aebef38a17 |
|
MD5 | 3b17feaf0633f96f251725b6f1d7fe08 |
|
BLAKE2b-256 | 66b923febcfae0ee3f7587a8c4deaefe8ee03f5b2a7713714282ae459d80dbdf |