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.10.13.17.44814.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 808e7e4dce5e66ff34b54a6f9fa0ee829880b89246fb1868a60fb5f08c452be8 |
|
MD5 | c5fdf504a1d159e96cd943a0e7e37d97 |
|
BLAKE2b-256 | 90cc9e5d57a6f1c86cacedf5d84c214019d4a36c7436bb4b0ace58b02c4fd6fb |
Hashes for RelevanceAI_dev-0.21.1.2021.12.12.10.13.17.44814-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1cc79b5902f756e08f90d718fd3614d545a9eb527729f207bc0edc52a4796028 |
|
MD5 | 3401ba2d34831798652e49e95c4f4b8b |
|
BLAKE2b-256 | afe3ca760244cfd5f3aea27b8398f49e5d085e20650f930256a8060ab169b880 |