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.12.57.37.304539.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3d7a53694ba5c8a062d71d1f899cec0a3ef3190e8107b27001654751a6385af |
|
MD5 | e390dfb37e1d7a803eb2a28af6849f5e |
|
BLAKE2b-256 | 76b1a1fcddd4503c8620fb068b22ec75768466ccab970341f24a6fc2f63acbf4 |
Hashes for RelevanceAI_dev-0.21.1.2021.12.12.12.57.37.304539-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 475e5a5a2bbcbacc4937726042a7159ba1ed9d728cc2a8177c7ccc9c63664335 |
|
MD5 | cecd2b4fba5d57529684aeaab8b72d48 |
|
BLAKE2b-256 | 7bcf59a5092e6ab0b43c245b0616f31f4d2079ed3400881737f8d91ad08461dc |