Application Usage

Application Usage Documentation

See README.md in root folder for instructions on running Pyrenote locally.

Using the site:

Homepage

• Login to the site using the creditals given to you by a user
• if you are the first user, use the login information you created while setting up Pyrenote.
• You can make a account by creating a create new account. You will be automatically assigned projects marked as example by Admins

Admin Portal

• Only accessible by admins
• To create a project, click to the plus button in the top right corner.
• Each project has 6 buttons that can alter properties about the project
  • to add a new user, hit the +person button and select users to add
  • hitting the tab button allows users to create diffrent label categories
    • Each category can store diffrent labels
    • There are two label category types: Select and multiselect. Select only lets users pick one label, multiselect lets users pick serval
    • After creating a category, users can input serval diffrent labels as options for the label category
  • The clipboard button lets users change the name of the project and set the project as example
  • the data upload button allows users to select what files should be annotated. It also allows users to upload reference data where they can input in json format what categories the labels should be under.
  • The download button downloads all annotations as json or csv format.
  • The list button allows admins to disable/enable features for their project
• To create a new user, use the plus button in the user category of admin portal.

To go to Annotation page

• go to Dashboard
• Select a project to work on
• Select the file to annotate. Unannotated files appear in pending, annotated files appear in completed, and files that need review are listed in marked_for_review

Annotation page:

• Once the spectrogram loads, annotations can be produced by clicking and dragging on the spectrogram
• To navigate through the audio_file, users can use the scroll bar on the bottom of the spcetrogram or the skip buttons next to the play button
• When an annotation is created or clicked on, it becomes selected and the annotation section appears
• In this section, users can select the labels to assign to the label
• To save hit save all, to delete the currently selected clip, hit delete.
• The next/previous clip can be loaded with the previous and next buttons.
  • The navigation buttons here only go to a new file if the user has already labeled all annotations
  • Users can leave behind unlabeled annotation by hitting force next however
  • If users hit previous on the frist clip in the project or next in the last clip, the user is taken to the project's data page.