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.13.0.10.6.864783.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 646f2608b35461ac3087ac95d6df79604160a60d238f6dd82b14d15597ad2142 |
|
MD5 | 03f4728494012710d8440e5db7bbe053 |
|
BLAKE2b-256 | 6a4e7c7f1e38be5d714fbfbb9da40f6cdb6ef017b104c84ea1426639f75a7a84 |
Hashes for RelevanceAI_dev-0.21.1.2021.12.13.0.10.6.864783-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13b45f6e31d59af726ad099bd0837668acf97add908c7f5391fb78cced983f79 |
|
MD5 | d03f9db18905f362ddee17f0ba1cce0d |
|
BLAKE2b-256 | 44e1de77df5cead10dfc548bc95450b87863378742dae5879ffdbd2ed07fdf95 |