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.22.13.17.58.195475
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.22.13.17.58.195475.tar.gz | 64.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| RelevanceAI_dev-0.24.5.2021.12.22.13.17.58.195475-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 150.2 kB
Release files / RelevanceAI-dev-0.24.5.2021.12.22.13.17.58.195475.tar.gz
| Download URL | RelevanceAI-dev-0.24.5.2021.12.22.13.17.58.195475.tar.gz |
|---|---|
| Size | 64.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d4f38a9a04f8661f5462e87b8c17d62419879f2e37bc7805608e3a41ac8254d
|
|
BLAKE2b-256 checksum How to use checksums |
a036bbe277dcabd9e0d3e7cf3687856856de8b8dfba99ff3f1320b12f96cabe1
|
| 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.22.13.17.58.195475-py3-none-any.whl
| Download URL | RelevanceAI_dev-0.24.5.2021.12.22.13.17.58.195475-py3-none-any.whl |
|---|---|
| Size | 85.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
94150f0bbbd37536d6767af19014922d566115153354b5f6730adedadd075254
|
|
BLAKE2b-256 checksum How to use checksums |
cf0e0222e3dc98382b86e1e5f3ce9e91fd9fb1770d3701eb323bc73978555557
|
| 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
|
