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.2.51.5.72150.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e292aefda0a6eed26b4e62ac1cdf66f3ca1faa7fc3c14c5b952161baa7b60d5 |
|
MD5 | c9cde0000e5b7d24109b29bb9c70c87a |
|
BLAKE2b-256 | ea5e8a2809c9d451549c3142820a672165f2d57f2d7464db493aadecaaf67fc3 |
Hashes for RelevanceAI_dev-0.21.0.2021.12.10.2.51.5.72150-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87c4dff7435e3fa6b1aa155d08e41a20f24facd1221f3609da691bdff1edd99d |
|
MD5 | 7305b2fdfa5bb980304fcbf6b85f6464 |
|
BLAKE2b-256 | 557a8430623d65026c7f50af0e0fea3ba22c0d6fca497946e204288103a9f47e |