Skip to content

Commit

Permalink
fixed include path for the header file in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
faressc committed May 4, 2024
1 parent c6b67fa commit cc1dfd1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ An extensive anira usage guide can be found [here](docs/anira-usage.md).
The basic usage of anira is as follows:

```cpp
#include <anira/anira>
#include <anira/anira.h>

// Create a model configuration struct for your neural network
anira::InferenceConfig myNNConfig(
Expand Down
4 changes: 3 additions & 1 deletion docs/anira-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ To use anira in your real-time audio application, you need to create instances f
Start by specifying your model configuration using ``anira::InferenceConfig``. This includes the model path, input/output forms, batch size, and other critical settings that match the requirements of your model. When using a single backend, you define the model path and input/output shapes only once.

```cpp
#include <anira/anira.h>

anira::InferenceConfig hybridNNConfig(
// Model path and shapes for different backends
#ifdef USE_LIBTORCH
Expand Down Expand Up @@ -66,7 +68,7 @@ If your model requires costum pre- or post-processing, you can inherit from the
When your pre- and post-processing requires to access values from the ```anira::InferenceConfig``` struct, you can store the config as a member in your custom pre- and post-processor class. Here is an example of a custom pre- and post-processor. The config myConfig is provided in the "MyConfig.h" file.

```cpp
#include <anira/anira>
#include <anira/anira.h>
#include "MyConfig.h"

class MyPrePostProcessor : public anira::PrePostProcessor {
Expand Down

0 comments on commit cc1dfd1

Please sign in to comment.