Skip to content

Commit 807b2e6

Browse files
committed
update README
1 parent b1bc716 commit 807b2e6

File tree

1 file changed

+21
-14
lines changed

1 file changed

+21
-14
lines changed

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ for an account. SongExplorer was tested and built with version 12.1.
142142

143143
## Conda for all Platforms ##
144144

145-
Platform-specific installation instructions can be found at
145+
Platform-specific installation conda instructions can be found at
146146
[Mamba](https://mamba.readthedocs.io/en/latest/installation.html).
147147
You can either add it to an existing installation of
148148
[Conda](https://conda.io/projects/conda/en/latest/user-guide/install),
@@ -151,11 +151,11 @@ or install a fresh copy. If the latter, consider using
151151
On Macs you can also use [Homebrew](https://brew.sh/) to install conda
152152
and mamba.
153153

154-
Then, simply install Songexplorer its own environment:
154+
Then, simply install Songexplorer into its own environment:
155155

156156
$ mamba install songexplorer -n songexplorer -c janelia
157157

158-
Pay attention to the notice output at the end and demarcated with "*** IMPORTANT
158+
Pay attention to the notice at the end demarcated with "*** IMPORTANT
159159
!!! ***". Follow the directions therein to install platform-specific
160160
dependencies which are not in conda-forge.
161161

@@ -164,7 +164,7 @@ cuda-nvcc and set XLA_FLAGS in your environment. See the [Tensorflow
164164
installation](https://www.tensorflow.org/install/pip#step-by-step_instructions)
165165
directions for more details.
166166

167-
Finally, put these definitions in your .bashrc file (or .zshrc file on Mac OS
167+
Optionally, put these definitions in your .bashrc file (or .zshrc file on Mac OS
168168
Catalina and newer):
169169

170170
export SONGEXPLORER_BIN='conda run -n songexplorer --no-capture-output'
@@ -330,8 +330,9 @@ variables that need to be tailored to your specific resources.
330330

331331
### Locally ###
332332

333-
When running locally SongExplorer uses a custom job scheduler to manage the
334-
resources required by different tasks. The scheduler permits doing multiple
333+
When running locally SongExplorer uses a custom job scheduler,
334+
[aitch](https://github.com/JaneliaSciComp/aitch), to manage the
335+
resources required by different tasks. Scheduling permits doing multiple
335336
jobs at once, as well as queueing a bunch of jobs for offline analysis. By
336337
default, each task reserves all of your computer's CPU cores, GPU cards, and
337338
memory, and so only one job can be run at a time. To tailor resources according
@@ -612,7 +613,7 @@ PS_20130625111709_ch3.wav (<jobid>)" will appear in the status bar. It's font
612613
will initially be grey to indicate that it is pending, then turn black when it
613614
is running, and finally either blue if it successfully finished or red if it
614615
failed. Upon success you'll also see the wide pull-down menu to the left
615-
labelled "recording" briefly turn orange, and below that will appear a table
616+
labeled "recording" briefly turn orange, and below that will appear a table
616617
showing how many sounds met each criterion.
617618

618619
The result is a file of comma-separated values with the start and stop times
@@ -1386,7 +1387,7 @@ folder and sub-folders therein:
13861387
which SongExplorer and the anotator(s) agreed upon for each WAV file.
13871388

13881389
* "<sub-folder\>/\*-disjoint-{label,tic}-only<annotator\>.csv" contains the
1389-
intervals which only one of them labelled. There is a separate file for each
1390+
intervals which only one of them labeled. There is a separate file for each
13901391
annotator, with SongExplorer's file name containing the precision-recall
13911392
ratio used when making the ethograms (e.g. "only1.0pr"). The difference
13921393
between the "label" and "tic" files is that for the former any overlap in
@@ -1410,7 +1411,7 @@ diagrams the "pr" row of the corresponding CSV file.
14101411

14111412
* "congruence-{tic,label}-<word\>.pdf plots the congruence versus
14121413
threshold data contained in the corresponding CSV file. The vertical
1413-
line in the left panel labelled "sparse P/R" corresponds to the
1414+
line in the left panel labeled "sparse P/R" corresponds to the
14141415
threshold calculated by `Accuracy` on just the annotated points in time.
14151416
"dense P/R" is the threshold at which the "only SongExplorer" and "only
14161417
<Annotator\>" lines cross (or "not SongExplorer" if there are multiple
@@ -1454,8 +1455,8 @@ and a densely annotated test set by using
14541455
The Congruence button generates a bunch of "disjoint.csv" files:
14551456
"disjoint-everyone.csv" contains the intersection of intervals that SongExplorer
14561457
and all annotators agreed upon; "disjoint-only\*.csv" files contain the intervals
1457-
which only SongExplorer or one particular annotator labelled; "disjoint-not\*.csv"
1458-
contains those which were labelled by everyone except SongExplorer or a given
1458+
which only SongExplorer or one particular annotator labeled; "disjoint-not\*.csv"
1459+
contains those which were labeled by everyone except SongExplorer or a given
14591460
annotator. Choose one or all of these kinds and then use the
14601461
`Activations`, `Cluster`, and `Visualize` buttons as before.
14611462

@@ -1472,7 +1473,7 @@ The probability of relatively rare words will then be decreased in comparison
14721473
to more common ones, and vice versa, thereby adjusting the precision-to-recall
14731474
ratio accordingly.
14741475

1475-
The alternative to adusting probabilities is to adjust thresholds.
1476+
The alternative to adjusting probabilities is to adjust thresholds.
14761477
While this can be done by changing the `P/Rs` variable, doing so in this
14771478
way changes them equally for all words. A word-specific re-balancing of
14781479
false negatives and false positives can be achieved using thresholds derived
@@ -1504,7 +1505,7 @@ A new subfolder will be created in the `Logs Folder` with a graph folder
15041505
therein called "frozen-graph.ensemble.pb". To create a corresponding
15051506
thresholds file, follow the steps for measuring congruence as described
15061507
in the previous section ([Testing Densely](#testing-densely)): (1) use this
1507-
model to classify a densely labelled recording, (2) make an ethogram using
1508+
model to classify a densely labeled recording, (2) make an ethogram using
15081509
the thresholds file of one of the constituent models, and (3) calculate the
15091510
`Congruence`. A new thresholds file suffixed with "-dense" will be created.
15101511
Manually copy this file into the newly created ensemble folder, and use
@@ -1556,7 +1557,7 @@ model with the `Activations`, `Cluster`, and `Visualize` buttons as before.
15561557
Any non-overlapping clumps are evidence of unique vocalizations.
15571558

15581559
Finally it should be noted that large amounts of ambient and "other"
1559-
annotations can be in some cases be automatically labelled. If you can
1560+
annotations can be in some cases be automatically labeled. If you can
15601561
devise a way to position your microphone in a place and time for which no
15611562
natural sounds are made but for which the "room tone" is otherwise the
15621563
same, then the entire recording can be considered ambient. Similarly,
@@ -1910,6 +1911,12 @@ local build, and then execute the above commands again:
19101911
$ conda env remove --name songexplorer
19111912
$ conda build purge-all
19121913

1914+
To update the conda recipe, tag a new version and make a github release, then
1915+
update "meta.yaml" with the new version number and new hash for the tar.gz
1916+
asset:
1917+
1918+
$ openssl sha256 <github-tar-gz-file>
1919+
19131920
Currently, there is a [bug](https://github.com/mamba-org/mamba/issues/1826)
19141921
in mamba on apple silicon. The workaround is:
19151922

0 commit comments

Comments
 (0)