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.22.0.2021.12.13.8.29.19.474518.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | faf6b7625293fadc48157fe5dc2f6c387f5b38b5d45443054baf32ce3a199d09 |
|
MD5 | 6fe8c2e8a48aa6b450577b182f1201c5 |
|
BLAKE2b-256 | d907d57da12c4bcd7c714fd70ab3959840f1f3fd2dcc91a15e2c22b671bd4d43 |
Hashes for RelevanceAI_dev-0.22.0.2021.12.13.8.29.19.474518-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b6de93e7fc038117e2205dbd60b0be0dfc0c83a2d42186b1c81de21f4d60a99 |
|
MD5 | bc27e81d7e379241e13838d33a1a7b10 |
|
BLAKE2b-256 | 46684ddca1d439fb7816b674002942e17ecd9b122c926550e078bff2454a9f93 |