Metadata-Version: 2.1
Name: encord-active
Version: 0.1.18
Summary: Enable users to improve machine learning models in an active learning fashion via data, label, and model quality.
Home-page: https://encord.com/encord-active/
License: Apache-2.0
Keywords: encord,active,machine,learning,data,label,model,quality,test
Author: Cord Technologies Limited
Author-email: hello@encord.com
Requires-Python: >=3.9, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.8.*
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Quality Assurance
Provides-Extra: coco
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: av (>=9.2.0,<10.0.0)
Requires-Dist: encord (>=0.1.43,<0.2.0)
Requires-Dist: faiss-cpu (>=1.7.2,<2.0.0)
Requires-Dist: inquirer (>=2.10.0,<3.0.0)
Requires-Dist: loguru (>=0.6.0,<0.7.0)
Requires-Dist: matplotlib (>=3.5.3,<4.0.0)
Requires-Dist: natsort (>=8.1.0,<9.0.0)
Requires-Dist: numpy (>=1.23.1,<2.0.0)
Requires-Dist: opencv-python (==4.5.5.64)
Requires-Dist: pandas (>=1.4.3,<2.0.0)
Requires-Dist: pandera (>=0.13.4,<0.14.0)
Requires-Dist: plotly (>=5.10.0,<6.0.0)
Requires-Dist: psutil (>=5.9.4,<6.0.0)
Requires-Dist: pycocotools (>=2.0.6,<3.0.0); extra == "coco"
Requires-Dist: pydantic (>=1.10.2,<2.0.0)
Requires-Dist: python-dotenv (>=0.21.0,<0.22.0)
Requires-Dist: pytz (>=2022.2.1,<2023.0.0)
Requires-Dist: rich (>=12.6.0,<13.0.0)
Requires-Dist: scikit-learn (>=1.0.1,<2.0.0)
Requires-Dist: scipy (==1.8.1)
Requires-Dist: shapely (>=1.7.0,<2.0.0)
Requires-Dist: streamlit (==1.13.0)
Requires-Dist: streamlit-nested-layout (>=0.1.1,<0.2.0)
Requires-Dist: termcolor (>=2.0.1,<3.0.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Requires-Dist: torch (>=1.12.1,<2.0.0)
Requires-Dist: torchvision (>=0.13.1,<0.14.0)
Requires-Dist: typer (>=0.6.1,<0.7.0)
Requires-Dist: types-pytz (>=2022.2.1,<2023.0.0)
Requires-Dist: watchdog (>=2.1.9,<3.0.0)
Project-URL: Documentation, https://encord-active-docs.web.app/
Project-URL: Repository, https://github.com/encord-team/encord-active
Description-Content-Type: text/markdown

<p align="center">
<a href="https://encord-active-docs.web.app" target="_blank">Documentation</a> |
<a href="https://colab.research.google.com/drive/11iZE1CCFIGlkWdTmhf5XACDojtGeIRGS?usp=sharing" target="_blank">Try it Now</a> |
<a href="https://encord.com/encord_active/" target="_blank">Website</a> |
<a href="https://encord.com/blog/" target="_blank">Blog</a> |
<a href="https://join.slack.com/t/encordactive/shared_invite/zt-1hc2vqur9-Fzj1EEAHoqu91sZ0CX0A7Q" target="_blank">Slack Community</a>
</p>

<h1 align="center">
  <p align="center">Encord Active</p>
  <a href="https://encord.com"><img src="src/encord_active/app/assets/encord_2_02.png" width="150" alt="Encord logo"/></a>
</h1>

[![PRs-Welcome][contribute-image]][contribute-url]
![Licence][license-image]
[![PyPi project][pypi-package-image]][pypi-package]
![PyPi version][pypi-version-image]
[![Open In Colab][colab-image]][colab-notebook]

[![docs][docs-image]][encord-active-docs]
[!["Join us on Slack"][slack-image]][join-slack]
[![Twitter Follow][twitter-image]][twitter-url]

## ❓ What is Encord Active?

[Encord Active][encord-active-landing] is an open-source active learning framework that helps you find failure modes in your models and improve your data quality and model performance.

Use Encord Active to visualize your data, evaluate your models, surface model failure modes, find labeling mistakes, prioritize high-value data for re-labeling and more!

![video](resources/ea-demo.gif)

## 💡 When to use Encord Active?

Encord Active helps you understand and improve your data, labels, and models at all stages of your computer vision journey.
Whether you've just started collecting data, labeled your first batch of samples, or have multiple models in production.

![encord active diagram](resources/process-chart-ea.webp)

## Installation

The simplest way to install the CLI is using `pip` in a suitable virtual environment:

```shell
pip install encord-active
```

We recommend using a virtual environment, such as `venv`:

```shell
python3.9 -m venv ea-venv
source ea-venv/bin/activate
pip install encord-active
```

> `encord-active` requires [python3.9][python-39].
> If you have trouble installing `encord-active`, you find more detailed instructions on
> installing it [here][encord-active-docs].

## 👋 Quickstart

Get started immediately by sourcing your environment and running the code below.
This downloads a small dataset and launches the Encord Active App for you to explore:

```shell
encord-active quickstart
```

After opening the UI, we recommend you to head to the [workflow documentation][encord-active-docs-workflow] to see some common workflows.

## ⬇️  Downloading a pre-built project

The quickest way to get started is by downloading an existing dataset.
The download command will ask which pre-built dataset to use and will download it into a new directory in the current working directory.

```shell
$ encord-active download
$ cd /path/of/downloaded/project
$ encord-active visualise
```

The app should then open in the browser.
If not, navigate to [`localhost:8501`](http://localhost:8501).
Our [docs][encord-active-docs] contains more information about what you can see in the page.

## <img width="24" height="24" src="resources/logo.png"/> Importing an Encord Project

This section requires [setting up an ssh key][encord-docs-ssh] 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][encord-docs-ssh].

To import an Encord project, use this command:

`$ encord-active import project`

> There are also options for importing projects from, e.g,. KITTI, CVAT, and COCO. Find more details in [the documentation][encord-active-docs-workflow-import-data].

## ⭐ Concepts and features

### 📊 Quality metric

Quality metric are applied to your data, labels, and predictions to assign them quality metric scores.
Plug in your own or rely on Encord Actives prebuilt quality metrics.
The quality metrics automatically decompose your data, label, and model quality to show you how to improve your model performance from a data-centric perspective.
Encord Active ships with 25+ metrics and more are coming; [contributions][contribute-url] are also very welcome.

**Other core features:**

- [Model Decomposition](https://encord-active-docs.web.app/pages/model-quality/metrics)
- [Data Exploration](https://encord-active-docs.web.app/pages/data-quality/summary)
- [Similarity Search](https://encord-active-docs.web.app/workflows/Improve-your-data/similar-images)
- [Annotator Benchmarks](https://encord-active-docs.web.app/pages/label-quality/explorer/)
- [Data Tagging](https://encord-active-docs.web.app/workflows/tags/#steps)
- [COCO Exports](https://encord-active-docs.web.app/pages/export/filter_export)
- And much more!

Visit our [documentation][encord-active-docs] to learn more.

### Supported data:

| Data   |     | Labels          |     | Project sizes |                |
| ------ | --- | --------------- | --- | ------------- | -------------- |
| `jpg`  | ✅  | Bounding Boxes  | ✅  | Images        | 100.000        |
| `png`  | ✅  | Polygons        | ✅  | Videos        | 100.000 frames |
| `tiff` | ✅  | Segmentation    | ✅  |               |                |
| `mp4`  | ✅  | Classifications | 🟡  |               |                |
|        |     | Polylines       | 🟡  |               |                |

## 🧑🏽‍💻Development

### 🛠 Build your own metrics

Encord Active is built with customizability in mind. Therefore, you can easily build your own custom metrics 🔧 See the [Writing Your Own Metric][encord-active-docs-write-metric] page in the docs for details on this topic. If you need help or guidance feel free to ping us in the **[slack community](https://encordactive.slack.com)**!

## 🔖 Documentation

Find our documentation [here](https://encord-active-docs.web.app).

## 👪 Community and support

Join our community on [Slack][join-slack] to connect with the team behind Encord Active.

Also, feel free to [suggest improvements or report problems][report-issue] via github issues.

## 🎇 Contributions

If you're using Encord Active in your organization, please try to add your company name to the [ADOPTERS.md][adopters]. It really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big impact.

If you want to share your custom metrics or improve the tool, please see our [contributing docs][contribute-url].

### 🦸 Contributors

<a href="https://github.com/encord-team/encord-active/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=encord-team/encord-active" />
</a>

[@Javi Leguina](https://github.com/jleguina)

## Licence

This repository is published under the Apache 2.0 licence.

[adopters]: https://github.com/encord-team/encord-active/blob/main/ADOPTERS.md
[colab-notebook]: https://colab.research.google.com/drive/11iZE1CCFIGlkWdTmhf5XACDojtGeIRGS?usp=sharing
[contribute-url]: https://encord-active-docs.web.app/contributing
[encord-active-docs-workflow-import-data]: https://encord-active-docs.web.app/workflows/import-data
[encord-active-docs-workflow]: https://encord-active-docs.web.app/category/workflows
[encord-active-docs-write-metric]: https://encord-active-docs.web.app/metrics/write-your-own
[encord-active-docs]: https://encord-active-docs.web.app/
[encord-active-landing]: https://encord.com/encord-active/
[encord-docs-ssh]: https://docs.encord.com/admins/settings/public-keys/#set-up-public-key-authentication
[join-slack]: https://join.slack.com/t/encordactive/shared_invite/zt-1hc2vqur9-Fzj1EEAHoqu91sZ0CX0A7Q
[new-issue]: https://github.com/encord-team/encord-active/issues/new
[pypi-package]: https://www.piwheels.org/project/encord-active/
[python-39]: https://www.python.org/downloads/release/python-3915/
[report-issue]: https://github.com/encord-team/data-quality-pocs/issues/new
[slack-community]: https://encord-active.slack.com
[twitter-url]: https://twitter.com/encord_team
[colab-image]: https://colab.research.google.com/assets/colab-badge.svg
[contribute-image]: https://img.shields.io/badge/PRs-welcome-blue.svg
[docs-image]: https://img.shields.io/badge/docs-online-blue
[license-image]: https://img.shields.io/github/license/encord-team/encord-active
[pypi-package-image]: https://img.shields.io/pypi/v/encord-active
[pypi-version-image]: https://img.shields.io/pypi/pyversions/encord-active
[slack-image]: https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=white
[twitter-image]: https://img.shields.io/twitter/follow/encord_team?label=%40encord_team&style=social

