Skip to content

Commit

Permalink
Update docs (#162)
Browse files Browse the repository at this point in the history
* Update docs

- Update ModeratorFrontEnd README to explain there are two separate
  implementations
- Fix typos in the ModeratorFrontEnd contributing guide
- Add list of subteams to the main README
- Add orcasite as another related site in the main README

Signed-off-by: Dave Thaler <[email protected]>

* Updated now that the V2 is deployed at least for the API portion

Signed-off-by: Dave Thaler <[email protected]>

* Update subteams

Per feedback from Michelle
Reviewed by Scott

Signed-off-by: Dave Thaler <[email protected]>

---------

Signed-off-by: Dave Thaler <[email protected]>
  • Loading branch information
dthaler authored Sep 17, 2024
1 parent 4bd562a commit 4efa05e
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
/ModelEvaluation/ @pastorep @akashmjn
/ModelTraining/ @pastorep @bnestor
/ModeratorFrontEnd/ @micowan @dthaler
/NotificationSystem/ @micya @scottviers @dthaler
/NotificationSystem/ @skanderm @micya @scottveirs @dthaler
10 changes: 5 additions & 5 deletions ModeratorFrontEnd/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ You can contribute by
3. Joining the Orcasound open source organization on Github to edit the wiki and/or help review pull requests.

## Local Setup
You can get the ModeratortFrontEnd web client application running on your local machine by following the below steps:
1. The moderatorFrontend is an ASP.NET Core Blazor Web App, so you need to intall the Visual Studio 2022 (as of this writing).
You can get the ModeratorFrontEnd web client application running on your local machine by following the below steps:
1. The ModeratorFrontEnd is an ASP.NET Core Blazor Web App, so you need to intall the Visual Studio 2022 (as of this writing).
![blazor get started](../Docs/Images/Blazor.png)
2. Select *Visual Studio ASP.NET and Web Development* workload with Visual Studio 2022 download.
![visual studio ASP.NET and Web Development](../Docs/Images/Blazor-download-install.png)
![Visual Studio ASP.NET and Web Development](../Docs/Images/Blazor-download-install.png)
3. Install the downloaded .exe for the setup with the workload selected.
4. Clone the forked repo to your local machine.
5. Checkout the *main* branch.
5. Check out the *main* branch.
6. Open the project as a solution in Visual Studio 2022 to make changes to the files/project.
7. Run locally by selecting the *AIForOrcas.Client.Web.csproj* and starting the application from Debug option from the toolbar.
7. Run locally by selecting the *AIForOrcas.Client.Web.csproj* and starting the application from Debug configuration from the toolbar.

7 changes: 7 additions & 0 deletions ModeratorFrontEnd/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Moderator Front End System

This directory contains two separate moderator front end system implementations:

* AIForOrcas: this implementation is what is currently deployed at https://aifororcas.azurewebsites.net/ and https://aifororcasdetections.azurewebsites.net/swagger/index.html
* OrcaHello: this implementation is intended as the future replacement and is now deployed at https://aifororcasdetections2.azurewebsites.net/swagger/index.html

## AI For Orcas - Moderator Front End System

The moderator front end is responsible for presenting the candidate whale calls to the designated moderators so they can confirm the calls as legitimate or as false positives.
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,20 @@ To contribute a pull request for a specific subsystem, please read the correspon
- InferenceSystem | [README](InferenceSystem/README.md) | [Contributing Guidelines](InferenceSystem/CONTRIBUTING.md)
- ModelTraining | [README](ModelTraining/README.md) | [Contributing Guidelines](ModelTraining/CONTRIBUTING.md)

Current subteams and leads are as follows:
- Machine Learning and Artificial Intelligence (Lead: Patrick Pastore)
- Moderation Portal (Lead: Mike Cowan)
- User Experience (Lead: Claire Goetschel)
- Notification System (Lead: Skander Mzali)
- Infrastructure (Lead: Dave Thaler): this subteam deals with Azure and GitHub infrastructure

New volunteers are welcome in all subteams.

## General Resources
[Project Page](https://ai4orcas.net/portfolio/orcahello-live-inference-system/) - contains information about the system and a brief history of the project.

## Related Projects
- [ai4orcas.net](https://ai4orcas.net)
- [aifororcas-podcast](https://github.com/orcasound/aifororcas-podcast) - A tool to crowdsource labeling of whale calls in Orcasound's hydrophone data.
- [aifororcas-orcaml](https://github.com/orcasound/aifororcas-orcaml) - Original baseline machine learning model and data preparation code.
- [orcasite](https://github.com/orcasound/orcasite) - Authoritative site for node information

0 comments on commit 4efa05e

Please sign in to comment.