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.0.2021.12.10.2.51.19.220070.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 381383c05e0c4305712a964effc244b5fb3d0076f1d443323302731ad79b099c |
|
MD5 | a3b1ef73167266405d10ab91834ed803 |
|
BLAKE2b-256 | 5821c45302d73e5c527804a7c46c2e0c8fed74ea2c430f38dff53aac4a150a7a |
Hashes for RelevanceAI_dev-0.21.0.2021.12.10.2.51.19.220070-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9aafb9e628dbbd9fd8bd7261d7501cb2f6f120f85c59eb70ee59f5af82f564f |
|
MD5 | 496b3ecaa8418c803edde5626b79634e |
|
BLAKE2b-256 | cdd32581132da384aa784060bd65045d1bbe7cb6d223d015ec1d7cfa696a0721 |