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.19.2.2021.12.8.5.3.34.816420.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f51bee9d3a72202acc64c5eb3955aaf8ebea0df24edc38e7892e4e2f197ed58 |
|
MD5 | 9ce348fdd95d2e762cea3011f87a6e6c |
|
BLAKE2b-256 | 354f69ae119a04bd48bec7790d42f38e48f0d6fddd44d988a0f95171e0f01774 |
Hashes for RelevanceAI_dev-0.19.2.2021.12.8.5.3.34.816420-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50eb47bc5fb5c6d48463c84f06924b0bdad21734e5be24c582652b21c8a0ca9c |
|
MD5 | 9dd620506f29f230dee8a2ee93afa3d8 |
|
BLAKE2b-256 | 9d628ea281626a59daf2ca8073713585fbeef25fd20322531f561735090a834a |