Skip to content

Commit dc86bf4

Browse files
committed
Updated guide
1 parent a1927c5 commit dc86bf4

File tree

3 files changed

+38
-18
lines changed

3 files changed

+38
-18
lines changed

back/docs/user_guide/annotation_projects.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ the annotation interface, additional controls are available for creating
283283
annotations. These include Select, Create, and Delete options.
284284

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

295+
!!! tip "Copying Annotations"
296+
297+
In scenarios where multiple similar-looking sound events occur within a single
298+
clip, you can efficiently annotate them by creating a single sound event,
299+
adding all the relevant tags, and then copying the annotation to create clones.
300+
To achieve this, select the desired annotation, press the Control key, and drag
301+
a copy to the desired location. This feature streamlines the annotation process
302+
for repetitive sound events.
303+
295304
All annotations will be visible in the spectrogram alongside the current tags. A
296305
button next to the tags of a sound event annotation enables you to add more
297306
tags. Alternatively, click on a single tag to remove it from the annotation.
@@ -382,6 +391,6 @@ models and user annotators, or exploring the data further using the tools in the
382391
[Exploration section](exploration.md), you have a solid foundation to make the
383392
most of your annotations.
384393

385-
*[RoI]: Region of Interest
394+
\*[RoI]: Region of Interest
386395

387-
*[ML]: Machine Learning
396+
\*[ML]: Machine Learning

back/docs/user_guide/installation.md

+24-13
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ to suit your preferences and needs.
1515

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

2022
### Python Package
2123

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

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

39-
After the window displays the "ready" message, open your preferred browser and
40-
navigate to:
41+
After the window displays the "ready" message a browser will be opened on
42+
Whombat, or open your preferred browser and navigate to:
4143

4244
http://localhost:5000
4345

@@ -47,20 +49,29 @@ navigate to:
4749

4850
python -m whombat
4951

50-
## Login
52+
## First User
5153

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

56-
![login](../assets/img/login.png)
58+
!!! info "Your Information"
59+
60+
The details you provide here are stored locally on your computer and are
61+
not shared with others. However, if you decide to download and share a dataset
62+
or annotations, the information of the user who created them will be visible in
63+
the exported files. Therefore, your data will only be shared with the people
64+
you send these files to. If you wish to share your work, it is essential to
65+
provide your information so that others can attribute you correctly and contact
66+
you if needed.
5767

58-
!!! warning "First time"
68+
## Login
69+
70+
For returning users, Whombat welcomes you with a login form. Enter your username
71+
and password to access the home page. Whombat's user system supports multiple
72+
users, allowing for individual work tracking.
5973

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

6576
## Home Screen
6677

back/src/whombat/system/boot.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ def update_splash_screen(message: str) -> None:
8080
import pyi_splash # type: ignore
8181

8282
pyi_splash.update_text(message)
83-
except:
83+
except ImportError:
8484
return
8585

8686

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

9191
pyi_splash.close()
92-
except:
92+
except ImportError:
9393
return
9494

9595

0 commit comments

Comments
 (0)