Skip to content

Commit

Permalink
docs: refactor (#278)
Browse files Browse the repository at this point in the history
* Major docs refactoring

* docs: cli simplification (#287)

* docs: cli simplification

* chore: delete cli metricize command

* Docs (workflows): classification/object model performance (#284)

* docs: create evaluationg classification model performance workflow

* docs: fix object model performance evaluation

* docs: fix typos

* fix: pr revision

* docs: sdk content (#290)

* wip

* feat: embeddings notebook

* docs: fix of typos

* restructure: sdk importer utils

* quick content paste

* rebase with main branch

* docs: add end-to-end active learning tutorial

fix: minor rewordings

* Docs: add acquisition functions list/table (#291)

docs: add acquisition functions list/table

* docs: clean existent active learning section (#292)

* Remove incomplete workflow in favour of end-to-end tutorial

* docs: update heading levels for table of content

* docs: add references to the newer pages

Add references to the acquisition functions list/table and the end-to-end tutorial about easy active learning in MNIST.

* fix: update broken links

* fix: visualise to visualize

* fix: typos and other minors

* fix: linting

---------

Co-authored-by: NikolajEncord\Nikolaj Buhl <[email protected]>
Co-authored-by: David Sapiro <[email protected]>
Co-authored-by: Gorkem Polat <[email protected]>
Co-authored-by: Eloy Pérez Torres <[email protected]>
Co-authored-by: Eloy Pérez Torres <[email protected]>
  • Loading branch information
6 people authored Mar 27, 2023
1 parent 7cba338 commit 144d0ca
Show file tree
Hide file tree
Showing 111 changed files with 2,475 additions and 2,355 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The download command will ask which pre-built dataset to use and will download i
```shell
encord-active download
cd /path/of/downloaded/project
encord-active visualise
encord-active visualize
```

The app should then open in the browser.
Expand All @@ -111,11 +111,11 @@ encord-active init /path/to/data/directory

A project will be created using the data in the directory.

To visualise the project run:
To visualize the project run:

```shell
cd /path/to/project
encord-active visualise
encord-active visualize
```

You can find more details on the `init` command in the [CLI documentation][encord-active-docs-init].
Expand Down Expand Up @@ -171,7 +171,7 @@ Encord Active ships with 25+ metrics and more are coming; [contributions][contri
- [Similarity Search](https://docs.encord.com/active/docs/workflows/improve-your-data/similar-images)
- [Annotator Benchmarks](https://docs.encord.com/active/docs/pages/label-quality/explorer/)
- [Data Tagging](https://docs.encord.com/active/docs/workflows/tags/#steps)
- [Visualise TP/FP/FN](https://docs.encord.com/active/docs/category/model-quality)
- [Visualize TP/FP/FN](https://docs.encord.com/active/docs/category/model-quality)
- [Dataset Balancing](https://docs.encord.com/active/docs/pages/export/balance_export)
- [COCO Exports](https://docs.encord.com/active/docs/pages/export/filter_export)
- And much more!
Expand Down
49 changes: 0 additions & 49 deletions docs/docs/active-learning/active-learning-workflow.md

This file was deleted.

9 changes: 1 addition & 8 deletions docs/docs/active-learning/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,7 @@ This is the idea behind active learning.

**Encord Active** provides you with the tools to take advantage of the active learning method, and it's integrated with **Encord Annotate** to deliver the best annotation experience.

If you are already familiar with the active learning foundation, continue your read with an exploration of **Encord Active**'s acquisition functions and common workflows.

import DocCardList from "@theme/DocCardList";

<DocCardList />
If you are already familiar with the active learning foundation, continue your read with an exploration of [Encord Active's acquisition functions](/metrics/model-quality-metrics/#acquisition-functions) and our end-to-end tutorial about [easy active learning on MNIST](/tutorials/easy-active-learning-on-mnist).

## What is active learning?

Expand All @@ -23,7 +19,4 @@ This process is illustrated in the figure below.

![active-learning-cycle.svg](../images/active-learning/active-learning-cycle.svg)


Check out our [practical guide to active learning for computer vision](https://encord.com/blog/a-practical-guide-to-active-learning-for-computer-vision/) to learn more about active learning, its tradeoffs, alternatives and a comprehensive explanation on active learning pipelines.


Loading

0 comments on commit 144d0ca

Please sign in to comment.