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.2.59.33.664775.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53cca8843a6abe0e150683ce225a52873fac04011edcc1446e0c31faa98914a0 |
|
MD5 | 925c3841cd98ba8a2b120f2481866cd1 |
|
BLAKE2b-256 | 8ad44f312a7cfcdae579c429a3344e41d0cb5b5ed2e1b4bb2ff75c08de0097b4 |
Hashes for RelevanceAI_dev-0.19.2.2021.12.8.2.59.33.664775-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 333837a49fed310abbb4dc78f88063b078d2c40fdc61d838e8a0a5ab226a1b5d |
|
MD5 | 8594b3f120cb6a2519b77ca6c8b07147 |
|
BLAKE2b-256 | 03aaa429be5b9a1721dfd5f68c295083fa1155ff945b38fcbdab9455bb901804 |