Issues to be addressed before release
Hi @xuhui_liu , I have reviewed the Kedgi app. Good work. Please take some time to fix the issues listed below. Thanks.
-
In the environment files, change the environment name from adi_env to kedgi_env. Remember to also change the name in run_app.sh, the readme file, the doc files, and everywhere else the name is used.
-
The repository takes up almost 500 MB! Why is it so large? Would be good to reduce the size considerably.
-
Under settings -> advanced, change the path of the project from acoustic_detector_interface to kedgi.
-
The readme file should start with a high-level introduction to the app, which explains what the purposes of the app is, etc. Also, this first paragraph should contain a link to the sphinx docs. For inspiration, see for example the readme file of Kadlu or Ketos. (The same high-level intro can be used in the sphinx docs)
-
The paragraph describing how to run the app also contains installation instructions, which belong in the previous paragraph. Please separate correctly.
-
In the sphinx docs, I would suggest to separate the two tutorials into two separate pages. Also I would make it more clear that the first tutorial is for users, whereas the second tutorial is for developers.
-
Is the data folder needed? It only contains a single file called grunt.csv.
-
I cannot find the toy_detector_1.zip file.
-
Does the docs/build folder need to be included in the repository? I do not think so ...
-
In the sphinx docs, I would replace 'Platform of underwater acoustic detections and classifications models' with 'Graphical interface for acoustic detectors' or something along those lines