Skip to content

Commit a057fca

Browse files
rpranabPranab Rajbhandari
and
Pranab Rajbhandari
authored
changes (#1714)
Co-authored-by: Pranab Rajbhandari <pranabrajbhandari@Pranabs-MacBook-Pro.local>
1 parent 7d92ba0 commit a057fca

File tree

2 files changed

+68
-76
lines changed

2 files changed

+68
-76
lines changed

docs/en/alab/annotation_labs_releases/release_notes_6_8_0.md

Lines changed: 65 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -17,113 +17,105 @@ sidebar:
1717

1818
Release date: **11-15-2024**
1919

20-
## Automatic Tests for Classification Models and Results Visualization in Generative AI Lab - 6.9
21-
We are excited to introduce Generative AI Lab version 6.9.0, a feature-packed update that enhances your AI-powered project workflows with innovative capabilities and improved functionality. This release introduces new project types, advanced detection features, and model versioning, empowering users with greater flexibility and control over their projects.
20+
Generative AI Lab 6.8 introduces new features designed for users migrating from NLP Lab onto the newest version of Generative AI Lab. With the new Backup and Restore feature, you can transfer projects, annotated data, models, and configurations to the Generative AI Lab 6.8 and above. Simply back up your projects and resources to cloud storage services like Azure Blob or AWS S3, then restore them directly into the new environment, entirely through the user interface.
2221

23-
With this update, you can streamline tasks such as checkbox identification, handwritten text detection, and model management, ensuring an optimized and user-friendly experience. Let’s dive into the highlights of this release.
22+
This release also introduces other small enhancements to existing features, including a “None” option in the de-identification dropdown, allowing you to label text without altering the original content. We’ve also added a helpful visual indicator for labels with associated annotation guidelines—now marked with a colored dot matching the label’s color.
2423

25-
## Identify and Validate Checkboxes with Precision
26-
Version 6.9.0 introduces a feature, a new project type called **Checkbox Detection**. With the new update, users are now able to use the model offered by Generative AI Lab to identify checkboxes in the tasks, including the **checked** and **unchecked** status in the respective tasks.
24+
## Migrate your NLP Lab Backup to Generative AI Lab
25+
Migration to the new version is now a seamless process. Users of the NLP Lab can transfer their models, projects, annotated data and configuration settings to the Generative AI Lab using our Backup and Restore feature. Once backed up, configurations can be easily restored to a Generative AI Lab server. To migrate your data, the process is as follows:
2726

28-
This project type can be selected from the **Content Type** page under **Image** tab during project configuration. The default model associated with Checkbox Detection is automatically downloaded from the **Models Hub** page and added to the project configuration.
27+
### Steps to Backup Data from NLP Lab
28+
1. **Login** to your current NLP Lab deployment as the admin user.
29+
2. Go to the **`System Settings`** page.
30+
3. Navigate to the **`Backup`** tab.
31+
4. Enter the required **backup details**.
32+
5. Schedule an immediate backup using the **`Backup now`** feature.
33+
6. Monitor the **backup pod status** to ensure the process completes successfully.
34+
```bash
35+
kubectl get pods
36+
```
37+
**Verify Backup:** Upon completion, your backed-up database and files will be visible in cloud storage.
2938

30-
![690image](/assets/images/annotation_lab/6.8.0/1.png)
39+
<iframe width="800" height="450" src="https://www.youtube.com/embed/wUiDq5peZK4?si=v2Q6XCtK01KmcKJa&hd=1" title="NLP Lab to Generative AI Lab migration - Step 1" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
3140

32-
After the project is configured, users can add relevant tasks and leverage the model to detect checkboxes and their respective checked and unchecked statuses.
3341

34-
![690image](/assets/images/annotation_lab/6.8.0/2.png)
42+
### Steps to Restore Data
3543

36-
This new update integrates seamlessly with the existing workflow, ensuring no changes or disruptions to the current application processes.
44+
1. **Deploy** a fresh instance of Generative AI Lab version 6.8.0 or higher from the marketplace.
45+
2. **Login** to the UI as the admin user.
46+
3. Go to the **`System Settings`** page.
47+
4. Click on the **`Restore`** tab and fill in the necessary details.
48+
5. Click on **`Restore Now`** to initiate the process.
49+
6. Monitor the **restore pod status** to ensure successful completion.
50+
```bash
51+
kubectl get pods
52+
```
3753

38-
## Detect and Validate Handwritten Text and Signatures
39-
Version 6.9.0 expands the capabilities of the platform with the addition of **Handwritten Text and Signature Detection**. This new feature enables the automatic identification and annotation of handwritten text and signatures within documents, powered by a specialized pre-trained model. The new project type can be selected from the **Content Type** page under **Image** tab during project configuration. Upon selection, the default model for Handwritten Text and Signature Detection is automatically downloaded from the **Models Hub** and integrated into the project configuration.
54+
**Verify Restoration:** Access the UI, all projects, models, data and files should now be successfully restored.
4055

41-
![690image](/assets/images/annotation_lab/6.8.0/3.png)
42-
43-
Users can then add relevant tasks to the project and use the model to identify and annotate handwritten content and signatures in documents efficiently.
44-
45-
![690image](/assets/images/annotation_lab/6.8.0/4.png)
46-
47-
This feature doesn't change the existing application workflow, maintaining consistency while enhancing functionality.
48-
49-
## Model Versioning with Training
50-
Generative AI Lab 6.9 introduces model versioning for the following project types: Named Entity Recognition (NER), Classification, Assertion, Relation, and Visual NER. In the **TRAINING SETTINGS** section of the **Train** page, a toggle labeled **Enable Versioning** is now available. By default, model versioning is disabled. To enable it, toggle **Enable Versioning** to **on**.
51-
52-
![690image](/assets/images/annotation_lab/6.8.0/5.png)
53-
54-
When enabled, models are saved with versioned names following the format **projecttype_projectname_v1**, **projecttype_projectname_v2**, and so on. If model deployment is enabled after training is complete, the most recently trained model is automatically applied to the project configuration. If model deployment after training is not enabled, the project configuration remains unchanged. All versions of trained models are accessible on the Reuse Resource page, allowing users to browse and select specific model versions for reuse in other projects.
55-
56-
![690image](/assets/images/annotation_lab/6.8.0/6.png)
57-
58-
Model versioning is also supported for previously created projects. If versioning is disabled, subsequent training overwrites the most recent model without creating a new version. When re-enabled, versioning resumes from the latest version rather than starting over from v1. This feature simplifies model management by enabling version tracking and reusability, offering seamless integration for new and existing projects.
59-
60-
Note: The **Enable Versioning** toggle is disabled during training.
56+
<iframe width="800" height="450" src="https://www.youtube.com/embed/8JihFXLfHGc?si=hczRk74snB9cP8Es&hd=1" title="NLP Lab to Generative AI Lab migration - Step 2" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
6157

6258
## Improvements
63-
### Enhanced label readability by using high-contrast default colors.
64-
To improve readability and accessibility, randomly assigned colors will now meet a minimum contrast standard by default, ensuring they are easy to read. This eliminates the need for users to adjust colors manually, saving time and enhancing usability.
65-
66-
![680image](/assets/images/annotation_lab/6.8.0/7.png)
67-
68-
### Improvements to the updater script
69-
1. A retry mechanism has been implemented to pull images during updates and installations. Each image will now be attempted up to three times to ensure successful retrieval.
59+
### Exclude Labels from De-identification
60+
Generative AI Lab 6.8 introduces a `None**` option in the de-identification selection dropdown. When selected, this option will only label the text without performing any de-identification. This provides users with greater flexibility by allowing them to annotate the text while leaving the original content intact.
7061

71-
When training or pre-annotation servers are running during an upgrade, a prompt appears:
72-
"**Do you want to proceed with deleting these pods? (y/N):**"
62+
![680image](/assets/images/annotation_lab/6.8.0/3.png)
7363

74-
- If "**No**" is selected, the upgrade process is exited.
75-
- If "**Yes**" is selected, the running training/pre-annotation pods are deleted, and the upgrade continues.
76-
- If no matching training or pre-annotation pods are running, the message "**No preannotator/training pods matching criteria found.**" is displayed, and the upgrade proceeds.
64+
### Mark the labels with annotation guideline
65+
A new enhancement has been introduced to easily distinguish labels with annotation guidelines. Labels that have associated annotation guidelines are now marked with a colored dot at the top-right corner. This feature applies to both NER and VisualNER projects. If the annotation guidelines are deleted for a label, the dot will be automatically removed.
7766

78-
2. A new "**silent**" flag can now be passed while executing the upgrade script.
67+
![680image](/assets/images/annotation_lab/6.8.0/4.png)
7968

80-
``./annotationlab-updater.sh --silent``
69+
### Change the pop-up message when the model downloading is canceled
70+
The pop-up message that appears when a model download is canceled has been updated for better clarity. Previously, the message displayed the title `Warning: Delete Model?`, which could confuse. It has now been changed to `Warning: Cancel Model Download?` with a more accurate description. This update provides clearer communication to users when they choose to stop a model download in progress, improving the overall user experience.
8171

82-
When "**silent**" flag is used:
83-
- It automatically deletes running training/pre-annotation servers without prompting.
84-
- It uses the default admin password for the upgrade procedure.
72+
![680image](/assets/images/annotation_lab/6.8.0/5.png)
8573

86-
## Bug Fixes [@dipendra]
87-
- **Prediction results are missing in Section Based Classification Projects when exported tasks are re-imported**
74+
### Improvements in XML editor
75+
The issue of overlapping parent option buttons and top child option buttons when hovered, specifically when the `Show parent action buttons on hover` option was enabled, has been resolved. This fix provides a more polished user experience by ensuring the buttons are properly aligned. Now, the buttons no longer interfere with each other, offering smoother interaction with the interface.
8876

89-
Previously, in Section-Based Classification projects, prediction results were missing when exported tasks were re-imported back to Generative AI Lab project. This issue has been resolved. Prediction results now remain intact when tasks are re-imported for SBA-enabled projects, ensuring data consistency.
77+
![680image](/assets/images/annotation_lab/6.8.0/6.png)
9078

91-
- **Multiple API calls are made during pre-annotation on the task page**
79+
Tooltips have been enhanced to display the correct tag name for each section, improving the usability of the XML editor. Previously, the tooltip and the menu name that appeared on hover were identical for each container, making it difficult to distinguish between them. With this update, each container now has a unique tooltip, ensuring that users can easily identify where they clicked. For example, `Edit Tag` has been updated to `Edit Text Tag` to provide clearer context and improve navigation within the editor.
9280

93-
In earlier versions, multiple API calls were made during pre-annotation on the **Task** page for de-identification projects, causing unnecessary random page refreshes. This issue has been resolved. The **Task** page now operates efficiently without making multiple API calls or unexpected refreshes.
81+
![680image](/assets/images/annotation_lab/6.8.0/7.gif)
9482

95-
- **De-identify dialog box is not updated after the server is ready with the de-identification pipeline**
83+
A validation error is now triggered when quick filters are incorrectly attached to elements other than labels or ellipse labels.
9684

97-
Previously, the de-identification dialog box was not displayed after the de-identification pipeline was deployed and ready for de-identification. This issue has been resolved. The pop-up now auto-refreshes and appears as expected once the de-identification pipeline is ready for deployment.
85+
![680image](/assets/images/annotation_lab/6.8.0/8.png)
9886

99-
- **Rule for section classifier is set to default value when the user navigates back to Relevant Page**
87+
The `Maximum rating value` of the `Rating` element now includes validation. A red color warning is displayed when an invalid value is entered. Only positive numbers are allowed, ensuring that users input appropriate values and improving the overall accuracy of ratings.
10088

101-
Previously, when users wanted to edit the section configuration and navigated to the **Relevant Sections** page, the classifier rule for the section classifier would reset to its default value. This issue has been resolved. For SBA-enabled projects, the selected classifier model is now correctly displayed in the dropdown when users return to the page for reconfiguration or confirmation.
89+
![680image](/assets/images/annotation_lab/6.8.0/9.png)
10290

103-
- **Training status still showing as 'Running' when the user checks the training history after aborting the training**
91+
### Increased readability for test cases view
92+
93+
Users can now read the test cases better with two-tone text distinguished between test types.
10494

105-
Previously, if a user aborted the deletion of a training pod from the cluster page and checked the training history, the status was incorrectly displayed as "**Running**" and the "**Failed**" status was shown in green. This issue has been resolved. The training history now accurately reflects the correct training status with the appropriate status color.
95+
![680image](/assets/images/annotation_lab/6.8.0/10.png)
10696

107-
- **When de-identification pipeline is deployed glove_100 is shown as deployed embeddings**
97+
### Bug Fixes
10898

109-
In earlier versions, the default embedding glove_100 was incorrectly displayed as deployed when the de-identification pipeline was deployed, even if no embeddings were available. This issue has been resolved. The correct embedding is now displayed when an embedding is used. An empty embedding is shown when no embedding is used. This ensures an accurate representation of the deployed embeddings in the pipeline.
99+
- **Annotation guidelines now visible in the horizontal layout**
100+
101+
Users can now see Annotation guidelines in the horizontal layout.
110102

111-
- **"Model type not available " error is seen frequently while navigating to the Train page**
103+
![680image](/assets/images/annotation_lab/6.8.0/11.png)
112104

113-
Previously, users frequently encountered the "**Model type not available**" error when navigating to the **Train** page. This issue has been resolved, and the error no longer appears while accessing the **Train** page from different locations within the project.
105+
- **Confidence score of classifier is only shown for the first section in SBA text task**
106+
107+
The confidence score is now correctly displayed for predictions across all sections, ensuring consistent feedback throughout the entire task.
114108

115-
- **Backup fails for Azure Blob Storage**
109+
![680image](/assets/images/annotation_lab/6.8.0/12.gif)
116110

117-
An issue affecting backups to Azure Blob Storage has been resolved. Backups now function correctly, ensuring reliable data storage and recovery.
111+
- **Toast Message-warning users of Expiring License with each API call**
112+
113+
The issue with frequent toast message pop-ups has been largely resolved. However, the message may still reappear when the user refreshes the page or navigates to different sections. While the message is now less intrusive, it is still visible during certain actions such as page reloads or navigation.
118114

119-
- **Labels with instructions cannot be deleted and added from the project configuration**
120-
121-
Previously, labels with instructions could not be added to or deleted from the project configuration. This issue has now been resolved, allowing users to seamlessly add labels with instructions or delete labels that contain instructions as needed.
122-
123-
- **Active learning is not triggered for the second trigger**
124-
If there is only one floating license, and it is being used by another server, the system previously failed to trigger training or wait for the license to become available when the active learning condition was met. This issue has now been resolved. Active learning will now wait for the license to be free before triggering training, ensuring a smoother and more reliable process. Additionally, when the active learning condition is met and the system is waiting for the license, this status will be displayed on the training page.
115+
- **File Backup is uploaded to the DB file backup path**
116+
117+
Users can now successfully designate different paths for ad-hoc backing up databases and files. The system will correctly store database ad-hoc backups in the specified database path, while file ad-hoc backups will be saved in their intended separate location.
125118

126-
127119
</div><div class="prev_ver h3-box" markdown="1">
128120

129121
## Versions

docs/en/alab/annotation_labs_releases/release_notes_6_8_1.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Release date: **11-26-2024**
2020
This hotfix addresses critical bugs and improves functionality for a smoother user experience.
2121

2222
### Bug Fixes
23-
- [ALAB-5891] Resolved an issue where users were unable to import zipped tasks exceeding 200 MB after implementing bulk file import functionality.
24-
- [ALAB-5912] Corrected label misalignment caused by incorrect indexing during pre-annotation.
25-
- [ALAB-5917] Fixed the "Access Denied" error encountered when navigating to the About Page.
23+
- Resolved an issue where users were unable to import zipped tasks exceeding 200 MB after implementing bulk file import functionality.
24+
- Corrected label misalignment caused by incorrect indexing during pre-annotation.
25+
- Fixed the "Access Denied" error encountered when navigating to the About Page.
2626

2727
### Task
2828
- [ALAB-5894] Updated the compatibility check logic to use editions instead of compatible_editions for verifying model compatibility with current Spark versions.

0 commit comments

Comments
 (0)