Skip to content

Commit f308dbb

Browse files
committed
Refinement of documentation and more
1 parent 79abd9b commit f308dbb

30 files changed

Lines changed: 1096 additions & 1122 deletions

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ anira::InferenceHandler inference_handler(pp_processor, inference_config);
4444
inference_handler.prepare({buffer_size, sample_rate});
4545

4646
// Select the inference backend
47-
inference_handler.set_inference_backend(anira::ONNX);
47+
inference_handler.set_inference_backend(anira::InferenceBackend::ONNX);
4848

4949
// Optionally get the latency of the inference process in samples
5050
unsigned int latency_in_samples = inference_handler.get_latency();

docs/anira-usage.md

Lines changed: 0 additions & 243 deletions
This file was deleted.

docs/benchmark-usage.md

Lines changed: 0 additions & 264 deletions
This file was deleted.

docs/sphinx/api/class/classanira_1_1InferenceConfig.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Enum anira::InferenceBackend
2+
============================
3+
4+
.. doxygenenum:: anira::InferenceBackend

docs/sphinx/api/enumlist.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Enum list
2+
==========
3+
4+
.. toctree::
5+
:glob:
6+
7+
enum/*

docs/sphinx/api/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,6 @@ API Documentation
55
:maxdepth: 1
66

77
classlist
8-
structlist
8+
structlist
9+
enumlist
10+
typedeflist
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Struct anira::InferenceConfig
2+
=============================
3+
4+
.. doxygenstruct:: anira::InferenceConfig
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Typedef anira::BufferF
2+
======================
3+
4+
.. doxygentypedef:: anira::BufferF
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Typedef anira::TensorShapeList
2+
==============================
3+
4+
.. doxygentypedef:: anira::TensorShapeList

0 commit comments

Comments
 (0)