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.0.2021.12.10.6.9.41.575726.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f2d1fe17b016b60cc109f659e43c35d4a77307a7e5835744a4a2e0baed6ae59 |
|
MD5 | 169cce232b37d5f1881aa4e9cedb9d3b |
|
BLAKE2b-256 | 9012d35a7e0cf5296f5ec0b8a63f74135f31d86ad3534176d0806cab0a4f6aea |
Hashes for RelevanceAI_dev-0.21.0.2021.12.10.6.9.41.575726-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f1fd6ffb5a6801bd216b07ecef41779dc5a1416a3674965b4379a53a44234a3 |
|
MD5 | 1ee4f2001d7a7fb7c25593154c8cff6a |
|
BLAKE2b-256 | a679a883e28ffe76bda4000256e06b2013537177cd6c436eaf4d401d6a11e5f8 |