Skip to content

prepare 25.4.1 release #316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mlikasam-askui merged 1 commit into from
Apr 21, 2025
Merged

prepare 25.4.1 release #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 4 additions & 16 deletions docs/docs/general/01-Getting Started/Installing AskUI/getting-started-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

<details>
Expand All @@ -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.
:::
Expand All @@ -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.
Expand Down
11 changes: 2 additions & 9 deletions docs/docs/general/01-Getting Started/Installing AskUI/getting-started-macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

<details>
Expand All @@ -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.
:::
Expand Down
4 changes: 0 additions & 4 deletions docs/docs/general/03-Element Selection/aielement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ title: AI Elements
<source src="https://files.askui.com/assets/docs/askui-bytes-aiElement.mp4"/>
</video>

:::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:

Expand Down
7 changes: 0 additions & 7 deletions docs/docs/suite/02-Components/AskUI-OCR-Teaching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down
43 changes: 26 additions & 17 deletions docs/docs/suite/ADE/annotations-for-training.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment on lines 9 to +13
Copy link
Copy Markdown
Contributor

@programminx-askui programminx-askui Apr 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is WorkspaceID Optional and the other not? We should here consitant


The results will be saved under:

- `$HOME/.askui/SnippingTool/Annotation/<WorkspaceId>/<GUID>.json`
- `$HOME/.askui/SnippingTool/Annotation/<WorkspaceId>/<GUID>.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
Expand All @@ -51,14 +48,13 @@ SYNOPSIS


SYNTAX
New-AskUIAnnotationsForTraining [-WorkspaceId <String>] [-Delay <Int32>] [-ConfigFile <String>] [<CommonParameters>]
New-AskUIAnnotationsForTraining [-WorkspaceId <String>] [-Token <String>] [-Delay <Int32>] [-Url <String>] [-ConfigFile <String>] [<CommonParameters>]


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.

Expand All @@ -67,9 +63,15 @@ PARAMETERS
-WorkspaceId <String>
(Optional) Workspace ID for the annotation.

-Token <String>
(Optional) Token for sending the annotation to the train endpoint.

-Delay <Int32>
(Optional) Delay in seconds before the screen freezes. Default is 0.

-Url <String>
(Optional) URL for the inference server. Default is https://inference.askui.com.

-ConfigFile <String>
*Experimental* (Optional) Absolute file path for the configuration to be loaded.

Expand All @@ -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"
```