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.14.28.4.581820.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b764b8f365906801848de213a5fe76943fca90be162bde5b1350eef0a9ac70c8 |
|
MD5 | d05726dfb60ea305ca3b90faeecb6b85 |
|
BLAKE2b-256 | 12c9ca2993eb978d52aaf60f78c729c0d1f39759b9ab664a6b5f8b0c3c2acc17 |
Hashes for RelevanceAI_dev-0.21.1.2021.12.12.14.28.4.581820-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bacad4cbda81e0cdbc35a6eaa124450b8d947c9b31b1799d1004c782e602efe |
|
MD5 | caf38a0ddf99287eb83e33ba46c32c65 |
|
BLAKE2b-256 | dc6c7a38b2dcfac32d58a5e3d53156f4401b0d9bfaf08c406674d6ec5210c199 |