Skip to content

Commit

Permalink
Updated guide
Browse files Browse the repository at this point in the history
  • Loading branch information
mbsantiago committed Jan 26, 2024
1 parent a1927c5 commit dc86bf4
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 18 deletions.
15 changes: 12 additions & 3 deletions back/docs/user_guide/annotation_projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ the annotation interface, additional controls are available for creating
annotations. These include Select, Create, and Delete options.

- Use the **Select** option to hover over and choose a single annotated sound
event by clicking on it. Once selected, you can edit its RoI or view its
event by clicking on it. Once selected, you can **Edit** its RoI or view its
details in the section below, including adding notes to this specific sound
event (**Sound Event Detail**, labeled **G** in the figure).
- The **Delete** mode allows you to hover over and select a single sound event
Expand All @@ -292,6 +292,15 @@ annotations. These include Select, Create, and Delete options.
annotation. The dropdown menu in the annotation controls lets you choose the
type of geometry to use.

!!! tip "Copying Annotations"

In scenarios where multiple similar-looking sound events occur within a single
clip, you can efficiently annotate them by creating a single sound event,
adding all the relevant tags, and then copying the annotation to create clones.
To achieve this, select the desired annotation, press the Control key, and drag
a copy to the desired location. This feature streamlines the annotation process
for repetitive sound events.

All annotations will be visible in the spectrogram alongside the current tags. A
button next to the tags of a sound event annotation enables you to add more
tags. Alternatively, click on a single tag to remove it from the annotation.
Expand Down Expand Up @@ -382,6 +391,6 @@ models and user annotators, or exploring the data further using the tools in the
[Exploration section](exploration.md), you have a solid foundation to make the
most of your annotations.

*[RoI]: Region of Interest
\*[RoI]: Region of Interest

*[ML]: Machine Learning
\*[ML]: Machine Learning
37 changes: 24 additions & 13 deletions back/docs/user_guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ to suit your preferences and needs.

The simplest way to dive into Whombat is by downloading our pre-packaged
executable file. We've tailored versions for Windows, Mac OS, and Ubuntu. Head
over to our GitHub repository's [releases](https://github.com/mbsantiago/whombat/releases) section to get the latest version.
over to our GitHub repository's
[releases](https://github.com/mbsantiago/whombat/releases) section to get the
latest version.

### Python Package

Expand All @@ -36,8 +38,8 @@ executable. This action spawns a new window that should resemble the following:

![boot](../assets/img/boot.png)

After the window displays the "ready" message, open your preferred browser and
navigate to:
After the window displays the "ready" message a browser will be opened on
Whombat, or open your preferred browser and navigate to:

http://localhost:5000

Expand All @@ -47,20 +49,29 @@ navigate to:

python -m whombat

## Login
## First User

Whombat welcomes you with a login form. Input your username and password to
access the home page. Whombat's user system allows for multiple users, keeping
track of everyone's work.
If this is your initial encounter with Whombat, you'll be greeted with a screen
to create your user profile. Please enter your details and set up your user
account.

![login](../assets/img/login.png)
!!! info "Your Information"

The details you provide here are stored locally on your computer and are
not shared with others. However, if you decide to download and share a dataset
or annotations, the information of the user who created them will be visible in
the exported files. Therefore, your data will only be shared with the people
you send these files to. If you wish to share your work, it is essential to
provide your information so that others can attribute you correctly and contact
you if needed.

!!! warning "First time"
## Login

For returning users, Whombat welcomes you with a login form. Enter your username
and password to access the home page. Whombat's user system supports multiple
users, allowing for individual work tracking.

If this is your inaugural run of Whombat, you won't have a username and
password. Not to worry, Whombat auto-generates a first user. Use the username
**admin** and password **admin** for your initial login. Afterward, you can
visit your profile to customize your username and password.
![login](../assets/img/login.png)

## Home Screen

Expand Down
4 changes: 2 additions & 2 deletions back/src/whombat/system/boot.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ def update_splash_screen(message: str) -> None:
import pyi_splash # type: ignore

pyi_splash.update_text(message)
except:
except ImportError:
return


Expand All @@ -89,7 +89,7 @@ def close_splash_screen() -> None:
import pyi_splash # type: ignore

pyi_splash.close()
except:
except ImportError:
return


Expand Down

0 comments on commit dc86bf4

Please sign in to comment.