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 data scientists/engineers 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.24.1.2021.12.22.2.43.45.866959.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99692c020e0c907ce8e6faa8d0a8687caf6aa67c65ba2b3adf40d28545d822a1 |
|
MD5 | 293715db9b3e0b2aa9d178b06e6b982c |
|
BLAKE2b-256 | 2fe5c0fde268a0f9140e107842fd88ad6fc691161a020c2184acff742cf7b781 |
Hashes for RelevanceAI_dev-0.24.1.2021.12.22.2.43.45.866959-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a732916fdf2e3773b527532c0bd49869ccfdaa72a93df590fc655bcfdb1f71a3 |
|
MD5 | 400be45f56690f8ffaf32e15fd9f5d6e |
|
BLAKE2b-256 | 320232f8ee092c853278fa689997d768648b419f3f6ca7b6e0fc233b33ccdfe8 |