Skip to content

Commit dd64f27

Browse files
stefantaubertstefantaubert
committed
add sphinx
1 parent 662f50a commit dd64f27

16 files changed

Lines changed: 765 additions & 0 deletions

‎docs/birdnet.acoustic_models.inference.encoding.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
birdnet.acoustic\_models.inference.encoding package
2+
===================================================
3+
4+
Submodules
5+
----------
6+
7+
birdnet.acoustic\_models.inference.encoding.benchmarking module
8+
---------------------------------------------------------------
9+
10+
.. automodule:: birdnet.acoustic_models.inference.encoding.benchmarking
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
birdnet.acoustic\_models.inference.encoding.result module
16+
---------------------------------------------------------
17+
18+
.. automodule:: birdnet.acoustic_models.inference.encoding.result
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
birdnet.acoustic\_models.inference.encoding.tensor module
24+
---------------------------------------------------------
25+
26+
.. automodule:: birdnet.acoustic_models.inference.encoding.tensor
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
birdnet.acoustic\_models.inference.encoding.worker module
32+
---------------------------------------------------------
33+
34+
.. automodule:: birdnet.acoustic_models.inference.encoding.worker
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: birdnet.acoustic_models.inference.encoding
43+
:members:
44+
:show-inheritance:
45+
:undoc-members:

‎docs/birdnet.acoustic_models.inference.prediction.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
birdnet.acoustic\_models.inference.prediction package
2+
=====================================================
3+
4+
Submodules
5+
----------
6+
7+
birdnet.acoustic\_models.inference.prediction.benchmarking module
8+
-----------------------------------------------------------------
9+
10+
.. automodule:: birdnet.acoustic_models.inference.prediction.benchmarking
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
birdnet.acoustic\_models.inference.prediction.result module
16+
-----------------------------------------------------------
17+
18+
.. automodule:: birdnet.acoustic_models.inference.prediction.result
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
birdnet.acoustic\_models.inference.prediction.tensor module
24+
-----------------------------------------------------------
25+
26+
.. automodule:: birdnet.acoustic_models.inference.prediction.tensor
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
birdnet.acoustic\_models.inference.prediction.worker module
32+
-----------------------------------------------------------
33+
34+
.. automodule:: birdnet.acoustic_models.inference.prediction.worker
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: birdnet.acoustic_models.inference.prediction
43+
:members:
44+
:show-inheritance:
45+
:undoc-members:

‎docs/birdnet.acoustic_models.inference.rst‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
birdnet.acoustic\_models.inference package
2+
==========================================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
birdnet.acoustic_models.inference.encoding
11+
birdnet.acoustic_models.inference.prediction
12+
13+
Submodules
14+
----------
15+
16+
birdnet.acoustic\_models.inference.benchmarking module
17+
------------------------------------------------------
18+
19+
.. automodule:: birdnet.acoustic_models.inference.benchmarking
20+
:members:
21+
:show-inheritance:
22+
:undoc-members:
23+
24+
birdnet.acoustic\_models.inference.consumer module
25+
--------------------------------------------------
26+
27+
.. automodule:: birdnet.acoustic_models.inference.consumer
28+
:members:
29+
:show-inheritance:
30+
:undoc-members:
31+
32+
birdnet.acoustic\_models.inference.files\_analyzer module
33+
---------------------------------------------------------
34+
35+
.. automodule:: birdnet.acoustic_models.inference.files_analyzer
36+
:members:
37+
:show-inheritance:
38+
:undoc-members:
39+
40+
birdnet.acoustic\_models.inference.perf\_tracker module
41+
-------------------------------------------------------
42+
43+
.. automodule:: birdnet.acoustic_models.inference.perf_tracker
44+
:members:
45+
:show-inheritance:
46+
:undoc-members:
47+
48+
birdnet.acoustic\_models.inference.producer module
49+
--------------------------------------------------
50+
51+
.. automodule:: birdnet.acoustic_models.inference.producer
52+
:members:
53+
:show-inheritance:
54+
:undoc-members:
55+
56+
birdnet.acoustic\_models.inference.result\_base module
57+
------------------------------------------------------
58+
59+
.. automodule:: birdnet.acoustic_models.inference.result_base
60+
:members:
61+
:show-inheritance:
62+
:undoc-members:
63+
64+
birdnet.acoustic\_models.inference.tensor module
65+
------------------------------------------------
66+
67+
.. automodule:: birdnet.acoustic_models.inference.tensor
68+
:members:
69+
:show-inheritance:
70+
:undoc-members:
71+
72+
birdnet.acoustic\_models.inference.worker module
73+
------------------------------------------------
74+
75+
.. automodule:: birdnet.acoustic_models.inference.worker
76+
:members:
77+
:show-inheritance:
78+
:undoc-members:
79+
80+
Module contents
81+
---------------
82+
83+
.. automodule:: birdnet.acoustic_models.inference
84+
:members:
85+
:show-inheritance:
86+
:undoc-members:

‎docs/birdnet.acoustic_models.inference_pipeline.rst‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
birdnet.acoustic\_models.inference\_pipeline package
2+
====================================================
3+
4+
Submodules
5+
----------
6+
7+
birdnet.acoustic\_models.inference\_pipeline.api module
8+
-------------------------------------------------------
9+
10+
.. automodule:: birdnet.acoustic_models.inference_pipeline.api
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
birdnet.acoustic\_models.inference\_pipeline.configs module
16+
-----------------------------------------------------------
17+
18+
.. automodule:: birdnet.acoustic_models.inference_pipeline.configs
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
birdnet.acoustic\_models.inference\_pipeline.encoding\_strategy module
24+
----------------------------------------------------------------------
25+
26+
.. automodule:: birdnet.acoustic_models.inference_pipeline.encoding_strategy
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
birdnet.acoustic\_models.inference\_pipeline.logs module
32+
--------------------------------------------------------
33+
34+
.. automodule:: birdnet.acoustic_models.inference_pipeline.logs
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:
38+
39+
birdnet.acoustic\_models.inference\_pipeline.prediction\_strategy module
40+
------------------------------------------------------------------------
41+
42+
.. automodule:: birdnet.acoustic_models.inference_pipeline.prediction_strategy
43+
:members:
44+
:show-inheritance:
45+
:undoc-members:
46+
47+
birdnet.acoustic\_models.inference\_pipeline.processes module
48+
-------------------------------------------------------------
49+
50+
.. automodule:: birdnet.acoustic_models.inference_pipeline.processes
51+
:members:
52+
:show-inheritance:
53+
:undoc-members:
54+
55+
birdnet.acoustic\_models.inference\_pipeline.resources module
56+
-------------------------------------------------------------
57+
58+
.. automodule:: birdnet.acoustic_models.inference_pipeline.resources
59+
:members:
60+
:show-inheritance:
61+
:undoc-members:
62+
63+
birdnet.acoustic\_models.inference\_pipeline.session module
64+
-----------------------------------------------------------
65+
66+
.. automodule:: birdnet.acoustic_models.inference_pipeline.session
67+
:members:
68+
:show-inheritance:
69+
:undoc-members:
70+
71+
birdnet.acoustic\_models.inference\_pipeline.strategy module
72+
------------------------------------------------------------
73+
74+
.. automodule:: birdnet.acoustic_models.inference_pipeline.strategy
75+
:members:
76+
:show-inheritance:
77+
:undoc-members:
78+
79+
Module contents
80+
---------------
81+
82+
.. automodule:: birdnet.acoustic_models.inference_pipeline
83+
:members:
84+
:show-inheritance:
85+
:undoc-members:

‎docs/birdnet.acoustic_models.perch_v2.rst‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
birdnet.acoustic\_models.perch\_v2 package
2+
==========================================
3+
4+
Submodules
5+
----------
6+
7+
birdnet.acoustic\_models.perch\_v2.model module
8+
-----------------------------------------------
9+
10+
.. automodule:: birdnet.acoustic_models.perch_v2.model
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
birdnet.acoustic\_models.perch\_v2.pb module
16+
--------------------------------------------
17+
18+
.. automodule:: birdnet.acoustic_models.perch_v2.pb
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
Module contents
24+
---------------
25+
26+
.. automodule:: birdnet.acoustic_models.perch_v2
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:

‎docs/birdnet.acoustic_models.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
birdnet.acoustic\_models package
2+
================================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
birdnet.acoustic_models.inference
11+
birdnet.acoustic_models.inference_pipeline
12+
birdnet.acoustic_models.perch_v2
13+
birdnet.acoustic_models.v2_4
14+
15+
Submodules
16+
----------
17+
18+
birdnet.acoustic\_models.base module
19+
------------------------------------
20+
21+
.. automodule:: birdnet.acoustic_models.base
22+
:members:
23+
:show-inheritance:
24+
:undoc-members:
25+
26+
Module contents
27+
---------------
28+
29+
.. automodule:: birdnet.acoustic_models
30+
:members:
31+
:show-inheritance:
32+
:undoc-members:

‎docs/birdnet.acoustic_models.v2_4.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
birdnet.acoustic\_models.v2\_4 package
2+
======================================
3+
4+
Submodules
5+
----------
6+
7+
birdnet.acoustic\_models.v2\_4.model module
8+
-------------------------------------------
9+
10+
.. automodule:: birdnet.acoustic_models.v2_4.model
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
birdnet.acoustic\_models.v2\_4.pb module
16+
----------------------------------------
17+
18+
.. automodule:: birdnet.acoustic_models.v2_4.pb
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
birdnet.acoustic\_models.v2\_4.tf module
24+
----------------------------------------
25+
26+
.. automodule:: birdnet.acoustic_models.v2_4.tf
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:
30+
31+
Module contents
32+
---------------
33+
34+
.. automodule:: birdnet.acoustic_models.v2_4
35+
:members:
36+
:show-inheritance:
37+
:undoc-members:

0 commit comments

Comments
 (0)