Add documentation #200
Merged
Add documentation #200
+1,865
−264
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add Doxygen-style documentation to all header files - Create Sphinx documentation structure with Breathe integration - Add WaveNet computation walkthrough with detailed step-by-step explanation - Configure Read the Docs integration (.readthedocs.yaml) - Update version to 0.4.0 across all configuration files - Remove duplicate get_dsp declarations from dsp.h Documentation includes: - Complete API reference for all classes and functions - Detailed WaveNet architecture walkthrough - Step-by-step computation explanations for Layer, LayerArray, and WaveNet - Architecture diagrams using Mermaid - Real-time safety and buffer management documentation
…allation - Uncommented the Python requirements section in .readthedocs.yaml to ensure that the documentation build process installs dependencies from docs/requirements.txt.
- Updated `get_dsp` calls in `benchmodel.cpp` and `loadmodel.cpp` to accept `std::filesystem::path` instead of raw string paths, enhancing path handling and compatibility with modern C++ standards. - Included necessary headers for filesystem support in both files.
- Updated requirements.txt to include sphinxcontrib-mermaid for enhanced diagramming capabilities in documentation. - Modified conf.py to enable the sphinxcontrib.mermaid extension, allowing for the integration of Mermaid diagrams in Sphinx documentation.
- Added commands to install Doxygen and generate XML output in .readthedocs.yaml. - Updated breathe_projects path in conf.py to reflect the new Doxygen output location. - Adjusted intersphinx_mapping for cpp documentation link to the correct URL.
- Added apt_packages section to .readthedocs.yaml for Doxygen installation. - Removed explicit Doxygen installation commands from the build process, simplifying the configuration.
- Updated .readthedocs.yaml to use a pre_build job for Doxygen instead of inline commands, streamlining the build process. - Maintained the existing apt_packages section for Doxygen installation.
- Refined data flow diagram to improve clarity by renaming nodes and adjusting connections. - Changed 'PostActFiLM' to 'PostActFilm' for consistency. - Updated output node names for better understanding, including 'Post-Activation Output' and 'Head Output'. - Enhanced overall structure of the diagram to reflect accurate data flow in the WaveNet architecture.
- Updated data flow diagram to include dimension annotations for data arrays, improving understanding of input and output shapes. - Renamed nodes in the diagram to reflect their dimensions, such as 'Input (dx,n)' and 'Residual (dx,n)', for better clarity. - Clarified notes regarding gating activation and head output dimensions to aid comprehension of the WaveNet architecture.
- Updated node labels in the data flow diagram to include quotation marks for consistency and clarity. - Enhanced the overall readability of the diagram by ensuring uniform formatting of node names, aiding in the understanding of the WaveNet architecture.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation includes: