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.14.12.57.603518.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0c98bde1ca42fab5126f04223164525c99a9e91a025dce23cb4fad30a8311176 |
|
MD5 | beab66fbd0206a39bd7fbb57488e433c |
|
BLAKE2b-256 | e4dce5621e8f0559333f40254239e8bfe6796862d1c4609ceb57892270ec5f05 |
Hashes for RelevanceAI_dev-0.21.1.2021.12.12.14.12.57.603518-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b2cdd60cf6f69d8728cbac04d647bc94454264e26ea6b3f74e24aaf44c26a00 |
|
MD5 | b30d457e6fc8ca9cbd29cd3c2ba72fe8 |
|
BLAKE2b-256 | b99a71b8a30da6869b2281cf7a8b573d0ff173796a9ad27dca80515b6783c24e |