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 (only available on Linux environments at the moment): 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()
1 maintainer
Metadata
1 maintainer
Release files for RelevanceAI-dev 0.24.5.2021.12.23.2.12.40.695078
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| RelevanceAI-dev-0.24.5.2021.12.23.2.12.40.695078.tar.gz | 64.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| RelevanceAI_dev-0.24.5.2021.12.23.2.12.40.695078-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 150.3 kB
Release files / RelevanceAI-dev-0.24.5.2021.12.23.2.12.40.695078.tar.gz
| Download URL | RelevanceAI-dev-0.24.5.2021.12.23.2.12.40.695078.tar.gz |
|---|---|
| Size | 64.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6769b53024064420863fb98bbad8343b8e3b207dd8d3199b5ef93dbb104e6b00
|
|
BLAKE2b-256 checksum How to use checksums |
ec425b987f5a211b5e2870a4aa23a82d409590763938bc94b086f80e0cd54e5b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
|
Release files / RelevanceAI_dev-0.24.5.2021.12.23.2.12.40.695078-py3-none-any.whl
| Download URL | RelevanceAI_dev-0.24.5.2021.12.23.2.12.40.695078-py3-none-any.whl |
|---|---|
| Size | 85.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9224b874c8890829b857a8ea8909c6d19f097d7551d8c396cb1e9c7a0a59664b
|
|
BLAKE2b-256 checksum How to use checksums |
57e0b988ac7b33a5bdaecc17eb580863a518206d5340e798d9ab605dedc26e3a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1
|
