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.11.17.918983.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77edeaff121b8d670b03153a1eac6ae5bd287d09d4dabc35da51a222fbb41391 |
|
MD5 | 8dc3c54c92e6a38b538e2d8382b2713a |
|
BLAKE2b-256 | 0d99c8a4ddb033aae1359b391961e8380d69c2b18a0d173668f2db89920a23ff |
Hashes for RelevanceAI_dev-0.21.1.2021.12.12.13.11.17.918983-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61a02fbac7b26e3a21ae1cd7fe9b56bb68e73e68339af38ffc29a038f5561e4f |
|
MD5 | 6bd384c56424dd1d5ff99e2aecca5998 |
|
BLAKE2b-256 | 7f5decab2d66c6271acfac9c18c79e63c5a667ebc31aeeda4fdb66688d5194d2 |