Enable users to improve machine learning models in an active learning fashion via data quality, label quality, and model assertions.
Project description
Encord Active
Documentation
Please refer to our documentation.
Installation
The simplest way to install the CLI is using pip
in a suitable virtual environment:
pip install encord-active
We recommend using a virtual environment, such as venv
:
$ python3.9 -m venv ea-venv
$ source ea-venv/bin/activate
$ pip install encord-active
encord-active
requires python3.9. If you have trouble installingencord-active
, you find more detailed instructions on installing it here.
Downloading a pre-built project
The quickest way to get started is by downloading an existing dataset. The download command will setup a directory where the project will be stored and will ask which pre-built dataset to use.
$ encord-active download
$ encord-active visualise /path/to/project
The app should automatically open in the browser. If not, navigate to localhost:8501
.
Our Docs contain more information about what you can see in the page.
Importing an Encord Project
This section requires setting up an ssh key with Encord, so slightly more technical.
If you haven't set up an ssh key with Encord, you can follow the tutorial in this link
To import an Encord project, use this script:
$ encord-active import project
Development
Write your own metrics
Encord Active isn't limited to the metrics we provided, it is actually quite easy to write your own 🔧 See the Writing Your Own Metric page on the WIKI for details on this.
Pre-commit hooks
If you have installed the dependencies with poetry, then you can install pre-commit hooks by running the following command:
$ pre-commit install
The effect of this will be that black
, isort
, mypy
, and pylint
needs to run without finding issues with the code before you are allowed to commit.
When you commit and either black
or isort
fails, committing again is enough, as the side effect of committing the first time is to reformat files.
Running each of the tools individually on your code can be done as follows:
$ poetry run black --config=pyproject.toml .
$ poetry run isort --sp=pyproject.toml .
$ poetry run mypy . --ignore-missing-imports
$ poetry run pylint -j 0 --rcfile pyproject.toml [subdir]
Community and Support
Join our community on Slack and Twitter!
Suggest improvements and report problems
Contributions
If you're using Encord Active in your organization, please try to add your company name to the ADOPTERS.md. It really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big impact.
Read the contributing docs.
Licence
This project is licensed under the terms of the AGPL-3.0 license.
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 encord_active-0.1.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66e1e65cdc182bd360e99041537acc99eb62b973624d9be07e8f0b64c9435baf |
|
MD5 | d80957ce9b03df7eb80f71ca759e2959 |
|
BLAKE2b-256 | 989c9cbd009b1e19ffd6e929f499bac209cb6a9e03cbe9381193d9b2dc3bb14b |