Skip to content

Commit 405810a

Browse files
rpranabPranab Rajbhandari
and
Pranab Rajbhandari
authored
Gen AI lab 6.8.0 release notes (#1597)
* changes for 680 release note * changes * updated release videos and removed installation options --------- Co-authored-by: Pranab Rajbhandari <pranabrajbhandari@Pranabs-MacBook-Pro.local> Co-authored-by: diatrambitas <JSL.Git2018>
1 parent a7b6250 commit 405810a

File tree

17 files changed

+978
-689
lines changed

17 files changed

+978
-689
lines changed
10.2 MB
Binary file not shown.
373 KB
Loading
314 KB
Loading
9.2 MB
Loading
15 MB
Binary file not shown.
558 KB
Loading
328 KB
Loading
395 KB
Loading
471 KB
Loading
2.24 MB
Loading
1.15 MB
Loading
833 KB
Loading
Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
---
2+
layout: docs
3+
header: true
4+
seotitle: Generative AI Lab | John Snow Labs
5+
title: Generative AI Lab Release Notes 6.8.0
6+
permalink: /docs/en/alab/annotation_labs_releases/release_notes_6_8_0
7+
key: docs-licensed-release-notes
8+
modify_date: 2024-08-25
9+
show_nav: true
10+
sidebar:
11+
nav: annotation-lab
12+
---
13+
14+
<div class="h3-box" markdown="1">
15+
16+
## 6.8.0
17+
18+
Release date: **11-15-2024**
19+
20+
## Easy Migration to Generative AI Lab - 6.8
21+
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.
22+
23+
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.
24+
25+
## Migrate your NLP Lab Backup to Generative AI Lab
26+
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:
27+
28+
### Steps to Backup Data from NLP Lab
29+
1. **Login** to your current NLP Lab deployment as the admin user.
30+
2. Go to the **`System Settings`** page.
31+
3. Navigate to the **`Backup`** tab.
32+
4. Enter the required **backup details**.
33+
5. Schedule an immediate backup using the **`Backup now`** feature.
34+
6. Monitor the **backup pod status** to ensure the process completes successfully.
35+
```bash
36+
kubectl get pods
37+
```
38+
**Verify Backup:** Upon completion, your backed-up database and files will be visible in cloud storage.
39+
40+
<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>
41+
42+
### Steps to Restore Data
43+
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+
```
53+
54+
**Verify Restoration:** Access the UI, all projects, models, data and files should now be successfully restored.
55+
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>
57+
58+
## Improvements
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.
61+
62+
![680image](/assets/images/annotation_lab/6.8.0/3.png)
63+
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.
66+
67+
![680image](/assets/images/annotation_lab/6.8.0/4.png)
68+
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.
71+
72+
![680image](/assets/images/annotation_lab/6.8.0/5.png)
73+
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.
76+
77+
![680image](/assets/images/annotation_lab/6.8.0/6.png)
78+
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.
80+
81+
![680image](/assets/images/annotation_lab/6.8.0/7.gif)
82+
83+
A validation error is now triggered when quick filters are incorrectly attached to elements other than labels or ellipse labels.
84+
85+
![680image](/assets/images/annotation_lab/6.8.0/8.png)
86+
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.
88+
89+
![680image](/assets/images/annotation_lab/6.8.0/9.png)
90+
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.
94+
95+
![680image](/assets/images/annotation_lab/6.8.0/10.png)
96+
97+
98+
### Bug Fixes
99+
- **Annotation guidelines now visible in the horizontal layout**
100+
101+
Users can now see Annotation guidelines in the horizontal layout.
102+
103+
![680image](/assets/images/annotation_lab/6.8.0/11.png)
104+
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.
108+
109+
![680image](/assets/images/annotation_lab/6.8.0/12.gif)
110+
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.
114+
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.
118+
119+
120+
</div><div class="prev_ver h3-box" markdown="1">
121+
122+
## Versions
123+
124+
</div>
125+
126+
{%- include docs-annotation-pagination.html -%}

docs/en/alab/backup_restore.md

Lines changed: 24 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -13,125 +13,41 @@ sidebar:
1313
nav: annotation-lab
1414
---
1515

16-
## Backup
16+
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.
1717

18-
You can enable daily backups by adding several variables with `--set` option to helm command in `annotationlab-updater.sh`:
18+
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.
1919

20-
```bash
21-
backup.enable=true
22-
backup.files=true
23-
backup.s3_access_key="<ACCESS_KEY>"
24-
backup.s3_secret_key="<SECRET_KEY>"
25-
backup.s3_bucket_fullpath="<FULL_PATH>"
26-
```
27-
28-
`<ACCESS_KEY>` - your access key for AWS S3 access
29-
30-
`<SECRET_KEY>` - your secret key for AWS S3 access
31-
32-
`<FULL_PATH>` - full path to your backup in s3 bucket (f.e. `s3://example.com/path/to/my/backup/dir`)
33-
34-
**Note:** File backup is enabled by default. If you don't need to backup files, you have to change
20+
## Migrate your NLP Lab Backup to Generative AI Lab
21+
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:
3522

23+
### Steps to Backup Data from NLP Lab
24+
1. **Login** to your current NLP Lab deployment as the admin user.
25+
2. Go to the **`System Settings`** page.
26+
3. Navigate to the **`Backup`** tab.
27+
4. Enter the required **backup details**.
28+
5. Schedule an immediate backup using the **`Backup now`** feature.
29+
6. Monitor the **backup pod status** to ensure the process completes successfully.
3630
```bash
37-
backup.files=true
38-
```
39-
40-
to
41-
42-
```bash
43-
backup.files=false
31+
kubectl get pods
4432
```
33+
**Verify Backup:** Upon completion, your backed-up database and files will be visible in cloud storage.
4534

46-
<br>
35+
<iframe src="/assets/images/annotation_lab/6.8.0/1.mp4" width="480" height="270" frameBorder="0" class="giphy-embed" allowFullScreen></iframe>
4736

48-
#### Configure Backup from the UI
37+
### Steps to Restore Data
4938

50-
In 2.8.0 release, Generative AI Lab added support for defining database and files backups via the UI. An _admin_ user can view and edit the backup settings under the **Settings** menu. Users can select different backup periods and can specify a target S3 bucket for storing the backup files. New backups will be automatically generated and saved to the S3 bucket following the defined schedule.
51-
52-
<img class="image image__shadow" src="/assets/images/annotation_lab/4.1.0/backupRestoreUI.png" style="width:100%;"/>
53-
54-
### Migrate your NLP Lab Backup to Generative AI Lab 6
55-
56-
Migrating to the new version is easy! Users who are using an older version of the NLP Lab can migrate their annotated data and configured settings to the new Generative AI Lab 6 through our Backup and Restore feature. This process enables users to back up their data and files from a CPU-based instance to the cloud of their choice (Azure Blob/AWS S3) and then restore the configurations to a GPU-based instance. You must follow the steps outlined below to seamlessly back up and restore all your data from an old instance to the new Generative AI Lab 6.
57-
58-
<iframe src="/assets/images/annotation_lab/6.0.0/BackupAndRestore.mp4" width="480" height="270" frameBorder="0" class="giphy-embed" allowFullScreen></iframe>
59-
60-
**Follow these steps to migrate your data**:
61-
#### 1. Backup Data:
62-
- Navigate to the Backup page of your CPU-based instance.
63-
- Enter backup details.
64-
- Schedule an immediate backup via backend modification:
65-
```bash
66-
kubectl edit cronjob
67-
```
68-
- Monitor the backup pod status:
39+
1. **Deploy** a fresh instance of Generative AI Lab version 6.8.0 or higher from the marketplace.
40+
2. **Login** to the UI as the admin user.
41+
3. Go to the **`System Settings`** page.
42+
4. Click on the **`Restore`** tab and fill in the necessary details.
43+
5. Click on **`Restore Now`** to initiate the process.
44+
6. Monitor the **restore pod status** to ensure successful completion.
6945
```bash
7046
kubectl get pods
7147
```
72-
#### 2. Verify Backup:
73-
- Upon completion, your backed-up database and files will be visible in cloud storage.
7448

75-
#### 3. Restore Data:
76-
- Access the backend of your target GPU-based instance.
77-
- Transfer backed-up data from cloud storage to artifacts/restore/database.
78-
- Perform database restoration:
79-
```bash
80-
sudo ./restore_all_databases.sh <backed-up_database_name>
81-
```
82-
- Copy backed-up files from cloud storage to artifacts/restore/files.
83-
- Execute file restoration:
84-
```bash
85-
sudo ./restore_files.sh <backed-up_files_name>
86-
```
87-
#### 4. Verify Restoration:
88-
- Access the UI, all data and files should now be successfully restored.
49+
**Verify Restoration:** Access the UI, all projects, models, data and files should now be successfully restored.
8950

51+
<iframe src="/assets/images/annotation_lab/6.8.0/2.mp4" width="480" height="270" frameBorder="0" class="giphy-embed" allowFullScreen></iframe>
9052

91-
## Restore
92-
93-
#### Database
94-
95-
To restore Generative AI Lab from a backup you need a fresh installation of Generative AI Lab. Install it using `annotationlab-install.sh`. Now, download the latest backup from your S3 bucket and move the archive to `restore/database/` directory. Next, go to the `restore/database/` directory and execute script `restore_all_databases.sh` with the name of your backup archive as the argument.
96-
97-
For example:
98-
99-
```
100-
cd restore/database/
101-
sudo ./restore_all_databases.sh 2022-04-14-annotationlab-all-databases.tar.xz
102-
```
103-
104-
> **Note:** <br>
105-
>
106-
> 1. You need `xz` and `bash` installed to execute this script. <br>
107-
> 2. This script works only with backups created by Generative AI Lab backup system. <br>
108-
> 3. Run this script with `sudo` command
109-
110-
After database restore complete you can check logs in `restore_log` directory created by restore script.
111-
112-
<br>
113-
114-
#### Files
115-
116-
Download your files backup and move it to `restore/files/` directory. Go to `restore/files/` directory and execute script `restore_files.sh` with the name of your backup archive as the argument. For example:
117-
118-
```
119-
cd restore/files/
120-
sudo ./restore_files.sh 2022-04-14-annotationlab-files.tar
121-
```
122-
123-
> **Note:** <br>
124-
>
125-
> 1. You need `bash` installed to execute this script. <br>
126-
> 2. This script works only with backups created by Generative AI Lab backup system. <br>
127-
> 3. Run this script with `sudo` command
128-
129-
<br>
130-
131-
#### Reboot
132-
133-
After restoring database and files, reboot Generative AI Lab:
134-
135-
```
136-
sudo reboot
137-
```
53+

0 commit comments

Comments
 (0)