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
.
You can also install on conda: conda install -c relevance 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.14.7.46.34.410092.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c6434ef21a65207f8f795934a59161f813114d169fdb997e2724e3ff41bb2dd |
|
MD5 | a0f004755d624686908b7c831f1eb5b9 |
|
BLAKE2b-256 | a818278d607134c9a9551787146f63907feeed57cabbfb635d63ad190fa0da52 |
Hashes for RelevanceAI_dev-0.22.0.2021.12.14.7.46.34.410092-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbcea50f7bf155079223b59d5b33d4f26ee2cfd3d2d2b4e98acb5a3e2d7fa31f |
|
MD5 | fa6cf592e19b5e34ab02392b64801004 |
|
BLAKE2b-256 | 18daf5735d89593cb8b3cf413eb695f986ae1c723c21c938be185c9374152a0a |