From fd475cbd319b9115a4a522be05e0ba511b9e96c2 Mon Sep 17 00:00:00 2001 From: Samir Mlika Date: Wed, 2 Apr 2025 14:58:10 +0100 Subject: [PATCH] prepare 25.4.1 release --- .../Installing AskUI/getting-started-linux.md | 20 ++------- .../Installing AskUI/getting-started-macos.md | 11 +---- .../general/03-Element Selection/aielement.md | 4 -- .../suite/02-Components/AskUI-OCR-Teaching.md | 7 --- .../suite/ADE/annotations-for-training.md | 43 +++++++++++-------- 5 files changed, 32 insertions(+), 53 deletions(-) diff --git a/docs/docs/general/01-Getting Started/Installing AskUI/getting-started-linux.md b/docs/docs/general/01-Getting Started/Installing AskUI/getting-started-linux.md index ae7dd851b..20cd8e061 100644 --- a/docs/docs/general/01-Getting Started/Installing AskUI/getting-started-linux.md +++ b/docs/docs/general/01-Getting Started/Installing AskUI/getting-started-linux.md @@ -27,14 +27,13 @@ Please [sign up for a free trial](https://www.app.askui.com). ```bash # Download installer into /tmp folder (AMD64) -curl -o /tmp/AskUI-Suite-24.12.1-User-Installer-Linux-x64-Full.run https://files.askui.com/releases/Installer/24.12.1/AskUI-Suite-24.12.1-User-Installer-Linux-x64-Full.run - +curl -L -o /tmp/AskUI-Suite-Latest-User-Installer-Linux-AMD64-Web.run https://files.askui.com/releases/Installer/Latest/AskUI-Suite-Latest-User-Installer-Linux-AMD64-Web.run ``` #### If you have ARM64 use this: ```bash # Download installer into /tmp folder (ARM64) -curl -o /tmp/AskUI-Suite-24.12.1-User-Installer-Linux-ARM64-Full.run https://files.askui.com/releases/Installer/24.12.1/AskUI-Suite-24.12.1-User-Installer-Linux-ARM64-Full.run +curl -L -o /tmp/AskUI-Suite-Latest-User-Installer-Linux-ARM64-Web.run https://files.askui.com/releases/Installer/Latest/AskUI-Suite-Latest-User-Installer-Linux-ARM64-Web.run ```
@@ -52,23 +51,16 @@ curl -o /tmp/AskUI-Suite-24.12.1-User-Installer-Linux-ARM64-Full.run https://fil ```bash # If you have AMD64 use this -bash /tmp/AskUI-Suite-24.12.1-User-Installer-Linux-x64-Full.run +bash /tmp/AskUI-Suite-Latest-User-Installer-Linux-AMD64-Web.run ``` #### Run the installer (ARM64) ```bash # If you have ARM64 use this -bash /tmp/AskUI-Suite-24.12.1-User-Installer-Linux-ARM64-Full.run +bash /tmp/AskUI-Suite-Latest-User-Installer-Linux-ARM64-Web.run ``` -* Press `Enter` to review the license agreement. Then press and hold Enter to scroll. -* Accept the license agreement. - -Answer the questions: -* Do you use a proxy? -* Do you want to make AskUI Command globally available? - :::tip Close and re-open your terminal window for the installation to take effect. ::: @@ -77,11 +69,7 @@ Close and re-open your terminal window for the installation to take effect. Open a terminal and run the following command: ```shell -# If you made the command globally available askui-shell - -# If you have NOT made the command globally available -~/.askui-suites/Tools/askui-shell ``` Activating the ADE may take a few seconds. diff --git a/docs/docs/general/01-Getting Started/Installing AskUI/getting-started-macos.md b/docs/docs/general/01-Getting Started/Installing AskUI/getting-started-macos.md index 70c1d1e43..f2cc5595b 100644 --- a/docs/docs/general/01-Getting Started/Installing AskUI/getting-started-macos.md +++ b/docs/docs/general/01-Getting Started/Installing AskUI/getting-started-macos.md @@ -26,7 +26,7 @@ Please [sign up for a free trial](https://www.app.askui.com). ```bash # Download installer into /tmp folder -curl -o /tmp/AskUI-Suite-24.12.1-User-Installer-MacOS-ARM64-Full.run https://files.askui.com/releases/Installer/24.12.1/AskUI-Suite-24.12.1-User-Installer-MacOS-ARM64-Full.run +curl -L -o /tmp/AskUI-Suite-Latest-User-Installer-MacOS-ARM64-Web.run https://files.askui.com/releases/Installer/Latest/AskUI-Suite-Latest-User-Installer-MacOS-ARM64-Web.run ```
@@ -43,16 +43,9 @@ curl -o /tmp/AskUI-Suite-24.12.1-User-Installer-MacOS-ARM64-Full.run https://fil Run the installer: ```bash -bash /tmp/AskUI-Suite-24.12.1-User-Installer-MacOS-ARM64-Full.run +bash /tmp/AskUI-Suite-Latest-User-Installer-MacOS-ARM64-Web.run ``` -* Press `Enter` to review the license agreement. Then press and hold Enter to scroll. -* Accept the license agreement. - -Answer the questions: -* Do you use a proxy? -* Do you want to make AskUI Command globally available? - :::tip Close and re-open your terminal window for the installation to take effect. ::: diff --git a/docs/docs/general/03-Element Selection/aielement.md b/docs/docs/general/03-Element Selection/aielement.md index e323045ff..c47f6a0b9 100644 --- a/docs/docs/general/03-Element Selection/aielement.md +++ b/docs/docs/general/03-Element Selection/aielement.md @@ -9,10 +9,6 @@ title: AI Elements -:::note -Enable the *AskUI Development Environment* as described in [AskUI Development Environment](../../suite/02-Components/AskUI-Development-Environment.md) and then activate the experimental commands by running `AskUI-ImportExperimentalCommands` in your terminal. -::: - ## `AskUI-NewAIElement` Command `AskUI-NewAIElement` allows you to capture elements from your screen. You can use these elements later in AskUI workflows. Accepted parameters: diff --git a/docs/docs/suite/02-Components/AskUI-OCR-Teaching.md b/docs/docs/suite/02-Components/AskUI-OCR-Teaching.md index 1e0d48872..345245611 100644 --- a/docs/docs/suite/02-Components/AskUI-OCR-Teaching.md +++ b/docs/docs/suite/02-Components/AskUI-OCR-Teaching.md @@ -8,16 +8,9 @@ sidebar_position: 3 Enable the *AskUI Development Environment* as described in [AskUI Development Environment](../../suite/02-Components/AskUI-Development-Environment.md) and then activate the experimental commands by running `AskUI-ImportExperimentalCommands` in your terminal. ::: -:::info -The app will be installed by default. You can choose not to install it by unchecking the checkbox. After installation, a shortcut named `AskUI OCR Teaching (Experimental)` will be added. -::: - This command launches the **AskUI OCR Teaching** application: ```powershell -# Import experimental commands. -AskUI-ImportExperimentalCommands - # Launch the OCR Teaching app. AskUI-StartOCRTeaching ``` diff --git a/docs/docs/suite/ADE/annotations-for-training.md b/docs/docs/suite/ADE/annotations-for-training.md index 17c3a0db2..90c28d1c1 100644 --- a/docs/docs/suite/ADE/annotations-for-training.md +++ b/docs/docs/suite/ADE/annotations-for-training.md @@ -8,34 +8,31 @@ The ADE Command `AskUI-NewAnnotationsForTraining` allows users to annotate their - `WorkspaceId` (Optional): Specifies the AskUI workspace ID to be used. If not specified, the workspace ID from the AskUI settings is used. - `Delay`: Time in seconds before the screen gets frozen. Default is 0. +- `Token`: Token for sending the annotation to the train endpoint. +- `Url`: URL for the inference server. Default is `https://inference.askui.com`. +- `ConfigFile`: *Experimental* Absolute file path for the configuration to be loaded. -The results will be saved under: - -- `$HOME/.askui/SnippingTool/Annotation//.json` -- `$HOME/.askui/SnippingTool/Annotation//.png` +The results will be sent to the train endpoint and the user will be informed about the success of the operation. ## Usage ```powershell -# Import experimental commands. -AskUI-ImportExperimentalCommands - AskUI-NewAnnotationsForTraining # Output -Finished taking of 2 annotationss. -Annotation #1 requires additional metadata. +Info: Finished taking of 2 annotationss. +Info: Annotation #1 requires additional metadata. Enter the category: custom button WARNING: Category must be one of the following: Text, Textfield, Button, Icon, CheckBox, Other. Enter the category: button - Enter the label: custom button Enter the description: dummy button with dummy colors -Annotation #2 requires additional metadata. +Info: Annotation #2 requires additional metadata. Enter the category: Text - Enter the label: login text Enter the description: a red login text with the text login -Processing data ... -Finished preparation of data package for training +Info: Processing data ... +Info: Finished preparation of data package for training. +Info: Sending annotation to train endpoint ... +Info: Finished sending annotation to train endpoint. ``` ## Help Output @@ -51,14 +48,13 @@ SYNOPSIS SYNTAX - New-AskUIAnnotationsForTraining [-WorkspaceId ] [-Delay ] [-ConfigFile ] [] + New-AskUIAnnotationsForTraining [-WorkspaceId ] [-Token ] [-Delay ] [-Url ] [-ConfigFile ] [] DESCRIPTION Starts the Snipping Tool and allows the user to annotate the screen. The user will be asked to provide additional metadata for each annotation. the metadata includes: - - label: The label for each annotation. - category: The category for each annotation. Valid categories are: 'Text', 'Textfield', 'Button', 'Icon', 'CheckBox', 'Other'. - description: The description for each annotation. @@ -67,9 +63,15 @@ PARAMETERS -WorkspaceId (Optional) Workspace ID for the annotation. + -Token + (Optional) Token for sending the annotation to the train endpoint. + -Delay (Optional) Delay in seconds before the screen freezes. Default is 0. + -Url + (Optional) URL for the inference server. Default is https://inference.askui.com. + -ConfigFile *Experimental* (Optional) Absolute file path for the configuration to be loaded. @@ -81,5 +83,12 @@ PARAMETERS -------------------------- EXAMPLE 1 -------------------------- - ADE> AskUI-NewAnnotationsForTraining + ADE>AskUI-NewAnnotationsForTraining + + Creates a new annotation for training. + +REMARKS + To see the examples, type: "Get-Help New-AskUIAnnotationsForTraining -Examples" + For more information, type: "Get-Help New-AskUIAnnotationsForTraining -Detailed" + For technical information, type: "Get-Help New-AskUIAnnotationsForTraining -Full" ``` \ No newline at end of file