Skip to content

Commit

Permalink
Docs Update
Browse files Browse the repository at this point in the history
Adding Tools Section
Fixing Broken Links
  • Loading branch information
hazza-music committed Nov 23, 2023
1 parent 263b89b commit 2702d26
Show file tree
Hide file tree
Showing 32 changed files with 620 additions and 242 deletions.
2 changes: 1 addition & 1 deletion _includes/head_custom.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<link rel="shortcut icon" type="image/png" href="https://soundstacks.github.io/docs/favicon.png" style="margin-top:20px" style="margin-bottom: 30px;">
<link rel="shortcut icon" type="image/png" href="https://cmajor-lang.github.io/docs/favicon.png" style="margin-top:20px" style="margin-bottom: 30px;">
2 changes: 1 addition & 1 deletion _includes/title.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@

<img src="https://soundstacks.github.io/docs/assets/images/Cmajor-Word-Logo.png" style="margin-top:20px;max-width: 150pt;max-height: 50pt;">
<img src="https://cmajor-lang.github.io/docs/assets/images/Cmajor-Word-Logo.png" style="margin-top:20px;max-width: 150pt;max-height: 50pt;">
7 changes: 0 additions & 7 deletions docs/CppAPI/helper-classes/helper-classes.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/CppAPI/main-api-classes/main-api-classes.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/Inference/onnx/onnx.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/Inference/rtneural/rtneural.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/PatchFormat/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Patch Format
permalink: /docs/PatchFormat
nav_order: 4
nav_order: 3
has_children: true
has_toc: false
---
Expand Down
2 changes: 1 addition & 1 deletion docs/ScriptFileFormat/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Script File Format
permalink: /docs/ScriptFileFormat
nav_order: 7
nav_order: 5
has_children: true
has_toc: false
---
Expand Down
737 changes: 553 additions & 184 deletions docs/StandardLibrary/main.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/TestFileFormat/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Test File Format
permalink: /docs/TestFileFormat
nav_order: 6
nav_order: 4
has_children: true
has_toc: false
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::AudioMIDIPerformer`
permalink: /docs/C++API#cmajaudiomidiperformer
permalink: /docs/Tools/C++API#cmajaudiomidiperformer
parent: Helper classes
grand_parent: C++ API
nav_order: 1
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::GeneratedCppEngine`
permalink: /docs/C++API#cmajgeneratedcppengine
permalink: /docs/Tools/C++API#cmajgeneratedcppengine
parent: Helper classes
grand_parent: C++ API
nav_order: 5
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::JUCEPluginBase` and `cmaj::JUCEPluginFormat`
permalink: /docs/C++API#cmajjucepluginbase-and-cmajjucepluginformat
permalink: /docs/Tools/C++API#cmajjucepluginbase-and-cmajjucepluginformat
parent: Helper classes
grand_parent: C++ API
nav_order: 4
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::Patch`
permalink: /docs/C++API#cmajpatch
permalink: /docs/Tools/C++API#cmajpatch
parent: Helper classes
grand_parent: C++ API
nav_order: 3
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::PatchManifest`
permalink: /docs/C++API#cmajpatchmanifest
permalink: /docs/Tools/C++API#cmajpatchmanifest
parent: Helper classes
grand_parent: C++ API
nav_order: 2
Expand Down
8 changes: 8 additions & 0 deletions docs/Tools/CppAPI/helper-classes/helper-classes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: default
title: Helper classes
permalink: /docs/Tools/C++API#helper-classes
parent: C++ API
grand_parent: False
nav_order: 2
---
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::BuildSettings`
permalink: /docs/C++API#cmajbuildsettings
permalink: /docs/Tools/C++API#cmajbuildsettings
parent: Main API classes
grand_parent: C++ API
nav_order: 5
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::DiagnosticMessageList`
permalink: /docs/C++API#cmajdiagnosticmessagelist
permalink: /docs/Tools/C++API#cmajdiagnosticmessagelist
parent: Main API classes
grand_parent: C++ API
nav_order: 4
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::EndpointDetails`, `cmaj::EndpointDetailsList`
permalink: /docs/C++API#cmajendpointdetails-cmajendpointdetailslist
permalink: /docs/Tools/C++API#cmajendpointdetails-cmajendpointdetailslist
parent: Main API classes
grand_parent: C++ API
nav_order: 6
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::Engine`
permalink: /docs/C++API#cmajengine
permalink: /docs/Tools/C++API#cmajengine
parent: Main API classes
grand_parent: C++ API
nav_order: 1
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::Performer`
permalink: /docs/C++API#cmajperformer
permalink: /docs/Tools/C++API#cmajperformer
parent: Main API classes
grand_parent: C++ API
nav_order: 2
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: `cmaj::Program`
permalink: /docs/C++API#cmajprogram
permalink: /docs/Tools/C++API#cmajprogram
parent: Main API classes
grand_parent: C++ API
nav_order: 3
Expand Down
8 changes: 8 additions & 0 deletions docs/Tools/CppAPI/main-api-classes/main-api-classes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: default
title: Main API classes
permalink: /docs/Tools/C++API#main-api-classes
parent: C++ API
grand_parent: False
nav_order: 1
---
8 changes: 3 additions & 5 deletions docs/CppAPI/main.md → docs/Tools/CppAPI/main.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
layout: default
title: C++ API
permalink: /docs/C++API
nav_order: 3
permalink: /docs/Tools/C++API
parent: Tools
has_children: true
has_toc: false
nav_order: 1
---

# The Cmajor native API

This document covers the API you'll need to use if you want to embed the Cmajor JIT engine into a native C++ app.
Expand Down
8 changes: 3 additions & 5 deletions docs/Inference/main.md → docs/Tools/Inference/main.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
layout: default
title: Machine Learning
permalink: /docs/MachineLearning
nav_order: 5
permalink: /docs/Tools/MachineLearning
parent: Tools
has_children: true
has_toc: false
nav_order: 2
---

# Machine Learning Tools in Cmajor

Cmajor makes a great platform for high-performance execution (inference) of real-time machine learning tasks. ML inference involves a lot of matrix operators, and the Cmajor JIT engine can do a great job of vectorising that kind of code. In most cases it equals or outperforms equivalent C++ code by taking advantage of processor-specific SIMD extensions where available, and is real-time safe by design.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Currently supported ONNX Operators:
permalink: /docs/MachineLearning#currently-supported-onnx-operators
permalink: /docs/Tools/MachineLearning#currently-supported-onnx-operators
parent: ONNX
grand_parent: Machine Learning
nav_order: 3
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: ONNX Operators
permalink: /docs/MachineLearning#onnx-operators
permalink: /docs/Tools/MachineLearning#onnx-operators
parent: ONNX
grand_parent: Machine Learning
nav_order: 1
Expand Down
8 changes: 8 additions & 0 deletions docs/Tools/Inference/onnx/onnx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: default
title: ONNX
permalink: /docs/Tools/MachineLearning#onnx
parent: Machine Learning
grand_parent: False
nav_order: 1
---
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Using the ONNX to Cmajor Python script
permalink: /docs/MachineLearning#using-the-onnx-to-cmajor-python-script
permalink: /docs/Tools/MachineLearning#using-the-onnx-to-cmajor-python-script
parent: ONNX
grand_parent: Machine Learning
nav_order: 2
Expand Down
8 changes: 8 additions & 0 deletions docs/Tools/Inference/rtneural/rtneural.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
layout: default
title: RTNeural
permalink: /docs/Tools/MachineLearning#rtneural
parent: Machine Learning
grand_parent: False
nav_order: 2
---
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Supported Operators
permalink: /docs/MachineLearning#supported-operators
permalink: /docs/Tools/MachineLearning#supported-operators
parent: RTNeural
grand_parent: Machine Learning
nav_order: 1
Expand Down
9 changes: 9 additions & 0 deletions docs/Tools/Tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: Tools
permalink: /docs/Tools
nav_order: 6
has_children: true
has_toc: true
---

0 comments on commit 2702d26

Please sign in to comment.