encord-team · Laverne-Encord · Mar 12, 2024
@@ -0,0 +1,94 @@
+---
+title: "Filtering"
+slug: "active-oss-filtering"
+hidden: false
+metadata: 
+  title: "Filtering"
+  description: "Enhance insights with data filtering in Encord Active: Identify patterns, remove duplicates, improve model behavior. Use standard filters, embedding plots, or natural language search"
+  image: 
+    0: "https://files.readme.io/9123073-image_16.png"
+createdAt: "2023-07-14T16:16:03.504Z"
+updatedAt: "2023-08-09T16:19:33.172Z"
+category: "65a71bbfea7a3f005192d1a7"
+---
+
+[block:html]
+{
+  "html": "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n    <meta charset=\"UTF-8\">\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n    <title>Aligned Image with Page Break</title>\n    <style>\n        .aligned-image {\n            display: block;\n            margin: auto; /* This centers the image */\n        }\n\n        .page-break {\n            page-break-after: always; /* This adds a page break after the image */\n        }\n    </style>\n</head>\n<body>\n    <img src=\"https://storage.googleapis.com/docs-media.encord.com/static/img/active/local_02.png\" width=\"200 alt=\"Your Image\" class=\"aligned-image\">\n    <div class=\"page-break\"></div>\n</body>\n</html>"
+}
+[/block]
+
+**Learn how to filter data in Encord Active**
+
+Filtering data in Encord Active is crucial for various reasons. It enables insights and actionable results on the following key aspects and more:
+1. Identification of patterns, trends, or anomalies within a subset of the data.
+2. Recognition of duplicates, outliers and inconsistencies.
+3. Removal of irrelevant, noisy and erroneous data.
+4. Understanding model's behaviour and potential skewness when facing different subsets of the data. 
+5. **[Encord project only]** Update tasks status to prioritize some unannotated images in the labeling stage and send labels to be reviewed/fixed, all along with descriptive comments for the project users (e.g. annotators and reviewers).
+
+Encord Active provides three data filtering methods:
+1. **Standard filter feature**: This option allows users to refine their search using metadata filters, user-defined tag filters, and metric filters.
+2. **Embedding plot**: A two-dimensional visualization technique used by Encord to represent high-dimensional data in a more interpretable form. Can be used to select points within a specific rectangular area, thereby focusing on a particular subset of data points for in-depth analysis.
+3. **Natural language search**: Enables users to enter descriptive queries in everyday language, making it easier to find relevant images without the need for specific keywords or complex search parameters.
+
+
+# Standard filter feature
+
+The standard filter feature offers the following filtering options:
+1. **Data points metadata filters**: Filter data points based on metadata attributes such as `Object Class` and `Annotator`, allowing to focus on specific classes or annotations created by particular annotators.
+2. **User-defined tag filters**: Apply filters based on user-defined tags, enabling categorization and filtering of data points according to custom tags. 
+3. **Metric filters**: Utilize metrics, including built-in ones like `Image Diversity` and `Label Duplicates`, as well as user-defined metrics, to filter data points based on potentially complex properties.
+
+[//]: # (Don't show this section in the ToC. Use H3 heading to make that happen.)
+### Steps to use the standard filter feature
+
+1. Go to the Explorer page and locate the filter feature.
+  ![Explorer page featuring the highlighted filter feature, allowing users to refine data visualization](https://storage.googleapis.com/docs-media.encord.com/static/img/active/user-guide/explorer-highlight-filter.png)
+2. Choose one or more filters from the available options.
+3. For numerical filters, specify the threshold range. For categorical filters, select the groups of interest.
+  ![Filtering data example with the `Red value` filter applied, narrowing down data points based on a specified threshold](https://storage.googleapis.com/docs-media.encord.com/static/img/active/user-guide/explorer-filter-by-red-values.png)
+
+> 👍 Tip
+> Take advantage of one of the UI components to personalize the visualization order of the filtered data based on a specific metric. You can choose to display the data in either ascending or descending order, depending on your preferences.
+>
+> ![Customize visualization order option in the UI](https://storage.googleapis.com/docs-media.encord.com/static/img/active/user-guide/explorer-component-order-by.png)
+
+
+# Embedding plot
+
+The embedding plot in Encord Active is a two-dimensional visualization technique used to represent high-dimensional data in a more interpretable and visually accessible form. By reducing the dimensionality of the data, the embedding plot helps preserve the underlying structure and patterns of the original data.
+
+In the plot, each data point is represented as a single point in the two-dimensional space, with proximity indicating similarity and shared characteristics among corresponding high-dimensional data points. This allows selecting points within a specific rectangular area, enabling a focused analysis of a particular subset of data points.
+
+By defining a rectangular area on the plot, users can quickly isolate and examine the data points that fall within that region. The selection can be based on specific criteria or visual observations, allowing further exploration of attributes or additional analysis on the chosen subset.
+
+This interactive functionality enhances the ability to gain deeper insights into underlying patterns and relationships within the selected area, providing a flexible and intuitive way to analyze and understand the data points within the dataset.
+
+Based on the selected option in the _Order by_ drop-down, users can choose to visualize either the embedding plot for the data or the labels.
+
+![Vibrant 2D embedding plot with distinct data points highlighting patterns and clusters](https://storage.googleapis.com/docs-media.encord.com/static/img/active/user-guide/explorer-embedding-plot.png)
+
+> 👍 Tip
+> In addition to selecting points within a rectangular area, the label embedding plot offers the functionality to filter data points based on the label classes.
+
+
+# Natural language search
+
+<details>
+<summary> Video Tutorial - Natural language search in EA </summary>
+
+[block:html]
+{
+  "html": "<div style=\"position: relative; padding-bottom: 56.25%; height: 0;\"><iframe src=\"https://www.loom.com/embed/c7da1b687690403a9d440707b5e38f32?sid=2fd7915a-665b-4fe2-bf37-613f87619fef\" frameborder=\"0\" webkitallowfullscreen mozallowfullscreen allowfullscreen style=\"position: absolute; top: 0; left: 0; width: 100%; height: 100%;\"></iframe></div>"
+}
+[/block]
+
+</details>
+
+The natural language search feature enables users to enter descriptive queries in everyday language, such as "images that contain baseball items". The system intelligently processes the query and retrieves images that match the description. This feature simplifies and greatly enhances the search experience within Encord Active, allowing finding relevant images without the need for specific keywords or complex search parameters.
+
+![Encord Active's natural language search in action, retrieving relevant images based on descriptive queries](https://storage.cloud.google.com/docs-media.encord.com/static/img/active/user-guide/explorer-natural-language-search.png)
+
+> ℹ️ Note
+> The natural language search feature is exclusively available in the hosted version of Encord Active.
@@ -0,0 +1,99 @@
+---
+title: "Relabeling"
+slug: "active-relabeling"
+hidden: false
+metadata: 
+  title: "Relabeling"
+  description: "Streamline data relabeling with Encord Active: Transfer data to Encord Annotate for enhanced annotation accuracy. Optimize labeling process."
+  image: 
+    0: "https://files.readme.io/77a0cfc-image_16.png"
+createdAt: "2023-07-12T09:21:52.521Z"
+updatedAt: "2023-08-11T12:43:00.519Z"
+category: "65a71bbfea7a3f005192d1a7"
+---
+
+[block:html]
+{
+  "html": "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n    <meta charset=\"UTF-8\">\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n    <title>Aligned Image with Page Break</title>\n    <style>\n        .aligned-image {\n            display: block;\n            margin: auto; /* This centers the image */\n        }\n\n        .page-break {\n            page-break-after: always; /* This adds a page break after the image */\n        }\n    </style>\n</head>\n<body>\n    <img src=\"https://storage.googleapis.com/docs-media.encord.com/static/img/active/local_02.png\" width=\"200 alt=\"Your Image\" class=\"aligned-image\">\n    <div class=\"page-break\"></div>\n</body>\n</html>"
+}
+[/block]
+
+**Learn how to submit your data for labeling in Encord Annotate**
+
+> Send and prioritize data for labeling from Encord Active is currently a closed-beta feature. To learn more about this feature, please reach out to us on [Slack][slack-join] or via [email](mailto:[email protected]).
+> Full documentation coming soon!
+> Reach out to us if you have urgent requests or catch us in Slack.
+
+
+[//]: # (When examining your project data, you might come across labels that appear incorrect or are missing altogether. With Encord Active, you have the ability to highlight such data and seamlessly transfer it to Encord Annotate, at the dedicated labeling stage for your project. This empowers annotators to address any missing elements and enhance the overall quality of your labels, ensuring a more accurate and comprehensive data annotation process.)
+
+[//]: # ()
+[//]: # (## Steps to send data to the labeling stage)
+
+[//]: # ()
+[//]: # (1. Go to the toolbox in the explorer pages and use the [filter feature]&#40;https://docs.encord.com/docs/active-filtering&#41; to choose the desired data.)
+
+[//]: # (   ![data-quality-explorer-filter-by-tag]&#40;https://storage.cloud.google.com/docs-media.encord.com/static/img/images/user-guide/data-quality-explorer-filter-by-tag.png&#41;)
+
+[//]: # (2. Locate and access the _Action_ tab in the same toolbox.)
+
+[//]: # (   ![toolbox-action-tab]&#40;https://storage.cloud.google.com/docs-media.encord.com/static/img/images/user-guide/toolbox-action-tab.png&#41;)
+
+[//]: # (3. Click the <kbd>🖋 Relabel</kbd> button.)
+
+[//]: # (   ![toolbox-action-tab-relabel-button]&#40;https://storage.cloud.google.com/docs-media.encord.com/static/img/images/user-guide/toolbox-action-tab-relabel-button.png&#41;)
+
+[//]: # (4. Verify that the number of tasks ready for submission to the labeling stage is correct and press the <kbd>Confirm</kbd> button.  )
+
+[//]: # (   ![toolbox-action-tab-relabel-button-confirmed]&#40;https://storage.cloud.google.com/docs-media.encord.com/static/img/images/user-guide/toolbox-action-tab-relabel-button-confirmed.png&#41;)
+
+[//]: # (5. **[Optional]** Navigate to the project in Encord Annotate and explore the task modifications in the _Summary_ tab.)
+
+[//]: # (<div style={{ display: "flex", justifyContent: "space-around", gap: "2em" }}>)
+
+[//]: # (  <div style={{ width: "45%", textAlign: "center" }}>)
+
+[//]: # (    <img)
+
+[//]: # (      src="https://storage.cloud.google.com/docs-media.encord.com/static/img/user-guide/workflow-project-summary.png")
+
+[//]: # (      width="100%")
+
+[//]: # (      alt="workflow-project-summary-before-relabeling.png")
+
+[//]: # (    />)
+
+[//]: # (    <p>Before sending the tasks to labeling</p>)
+
+[//]: # (  </div>)
+
+[//]: # (  <div style={{ width: "45%", textAlign: "center" }}>)
+
+[//]: # (    <img)
+
+[//]: # (      src="https://storage.cloud.google.com/docs-media.encord.com/static/img/user-guide/workflow-project-summary-after-relabeling.png")
+
+[//]: # (      width="100%")
+
+[//]: # (      alt="workflow-project-summary-after-relabeling.png")
+
+[//]: # (    />)
+
+[//]: # (    <p>After sending the tasks to labeling</p>)
+
+[//]: # (  </div>)
+
+[//]: # (</div>)
+
+[//]: # ()
+[//]: # ()
+[//]: # (> ℹ️ Note)
+
+[//]: # (> The **relabel feature** is currently limited to workflow projects.)
+
+[//]: # (> )
+
+[//]: # (> To upgrade your project to a workflow project, please reach out to us via [Slack][slack-join] or [email]&#40;mailto:[email protected]&#41;. Our team will be happy to assist you with the necessary steps and provide further guidance.)
+
+
+[slack-join]: https://join.slack.com/t/encordactive/shared_invite/zt-1hc2vqur9-Fzj1EEAHoqu91sZ0CX0A7Q
@@ -0,0 +1,58 @@
+---
+title: "Tagging"
+slug: "active-tagging"
+hidden: false
+metadata: 
+  title: "Tagging"
+  description: "Learn how tagging in the LOCAL version of Encord Active enhances data organization, search, and collaboration. Efficient workflow tips."
+  image: 
+    0: "https://files.readme.io/e8db7ee-image_16.png"
+createdAt: "2023-07-14T15:24:59.405Z"
+updatedAt: "2023-08-11T15:33:37.736Z"
+category: "65a71bbfea7a3f005192d1a7"
+---
+
+[block:html]
+{
+  "html": "<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n    <meta charset=\"UTF-8\">\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\n    <title>Aligned Image with Page Break</title>\n    <style>\n        .aligned-image {\n            display: block;\n            margin: auto; /* This centers the image */\n        }\n\n        .page-break {\n            page-break-after: always; /* This adds a page break after the image */\n        }\n    </style>\n</head>\n<body>\n    <img src=\"https://storage.googleapis.com/docs-media.encord.com/static/img/active/local_02.png\" width=\"200 alt=\"Your Image\" class=\"aligned-image\">\n    <div class=\"page-break\"></div>\n</body>\n</html>"
+}
+[/block]
+
+
+**Learn how to create tags in Encord Active**
+
+Tagging is a versatile feature used in almost all Encord Active workflows, whether you are relabeling, augmenting, exporting, or deleting data. You can tag images [individually](#individual-tagging) or in [bulk](#bulk-tagging).
+
+In Encord Active, tagging data provides several advantages:
+1. Organization: Tagging allows you to organize your data effectively within the platform. By assigning tags to your data points, you can group and categorize them based on common characteristics, making it easier to manage and navigate large subsets of the dataset.
+2. Enhanced search and filtering: Tags in Encord Active enable powerful search and filtering capabilities. You can search for specific data points or filter data based on tags, narrowing down your focus to the relevant information you need.
+3. Customizable metadata: Tags serve as customizable metadata that can provide additional context and information about your data. You can define and assign tags that align with your specific project requirements, providing meaningful insights and annotations for efficient data analysis.
+4. Collaboration and knowledge sharing: Tagging promotes collaboration and knowledge sharing among team members in Encord Active. With consistent tagging conventions, team members can easily understand and access tagged data, facilitating efficient collaboration and ensuring everyone is on the same page.
+
+These are just a few of the advantages of tagging in Encord Active, and there may be more benefits specific to your project and workflow.
+
+# Individual tagging
+
+**Steps to tag individual images or labels:**
+1. Access the Explorer page and locate the specific images or labels you want to tag.
+2. Select them by clicking on the checkbox in the top-left corner of each item.
+3. Look for the <kbd>TAG</kbd> button, positioned above the natural language search bar, and click on it to initiate the tagging process.
+4. Within the tagging interface, select the type of tag you want to apply. For images, choose the `data` type. For labels, select the `label` type.
+5. Provide a name for the tag you want to apply to the selected items. This name should reflect the relevant characteristic or information you want to associate with them.
+6. Press <kbd>Enter</kbd> to confirm the tag selection and apply it to the chosen items.
+7. **[Optional]** Validate the successful application of the tag by visually confirming its presence on the tagged items or using the filter options to isolate the tagged items based on the newly created tag.
+
+![tagging-individual-images](https://storage.cloud.google.com/docs-media.encord.com/static/img/images/user-guide/tagging-individual-images.png)
+
+# Bulk tagging
+
+**Steps to tag images or labels in bulk:**
+1. Access the Explorer page and utilize the [standard filter feature](https://docs.encord.com/docs/active-filtering#standard-filter-feature) to choose the desired data.
+2. Locate the <kbd>SELECT ALL</kbd> button, situated near the natural language search bar, and click on it to select the filtered items.
+3. Look for the <kbd>TAG</kbd> button, positioned above the natural language search bar, and click on it to initiate the tagging process.
+4. Within the tagging interface, select the type of tag you want to apply. For images, choose the `data` type. For labels, select the `label` type.
+5. Provide a name for the tag you want to apply to the selected items. This name should reflect the relevant characteristic or information you want to associate with them.
+6. Press <kbd>Enter</kbd> to confirm the tag selection and apply it to the chosen items.
+7. **[Optional]** Validate the successful application of the tag by visually confirming its presence on the tagged items or using the filter options to isolate the tagged items based on the newly created tag.
+
+![bulk-tagging](https://storage.cloud.google.com/docs-media.encord.com/static/img/images/user-guide/tagging-in-bulk.png)
@@ -0,0 +1,47 @@
+---
+title: "Versioning"
+slug: "active-versioning"
+hidden: true
+metadata: 
+  title: "Versioning"
+  description: "Learn data versioning in Encord Active: Track experiments, models, and project states. Global checkpoints for effective comparisons"
+  image: 
+    0: "https://files.readme.io/e269354-image_16.png"
+createdAt: "2023-07-12T09:21:53.085Z"
+updatedAt: "2023-08-11T13:54:16.572Z"
+category: "6480a3981ed49107a7c6be36"
+---
+
+**Learn how to version your data, labels, and models in Encord Active**
+
+### Why do you version your data?
+When you do experiments and test hypotheses, you typically want to jump back and forth between different versions of your data, labels, and models. For example, when you train a model on a specific subset of your data, you will typically find that there is an edge case for which your model performs poorly. Hence, you expand your dataset with more data to better cover the edge case and train a new model.
+
+In order to track your experiments and compare not only the model performance but also the underlying data shown to the model, you can use the project versioning feature of Encord Active.
+
+### What types of versioning are supported?
+
+The versioning is global for the project, covering everything from the available data and labels at a specific moment to the corresponding model predictions. This ensures that all relevant information is versioned and accessible.
+
+Currently, versioning operates through checkpoints, allowing you to create checkpoints and navigate between them to review previous states of the project.
+
+
+### How do I version my data?
+
+#### Creating a new version
+
+
+In order to create a new version, navigate to the toolbox in the explorer pages, access the _Version_ tab, provide a version name and click the <kbd>Create</kbd> button.
+
+![Version creation form](https://storage.cloud.google.com/docs-media.encord.com/static/img/images/version-creation-form.png)
+
+> 👍 Tip
+> You also have the ability to discard any outstanding changes, i.e. everything after the last version.
+
+
+#### Viewing a previous version
+
+On the left sidebar, there is a drop-down which allows version selection. Selecting an old version will temporarily save any outstanding changes until the latest version is selected again.
+
+> 🚧 Caution
+> While on a previous version the app will be in read-only mode. Any changes made will be discarded.