Skip to content
This repository has been archived by the owner on Jul 6, 2024. It is now read-only.

Commit

Permalink
Fix links in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@PolinaSavelyeva
PolinaSavelyeva committed Sep 15, 2023
1 parent 983f497 commit e196eba
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 27 deletions.
18 changes: 9 additions & 9 deletions docs/How_Tos/Making_A_Code.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ <h2><a name="Processing-on-CPU" class="anchor" href="#Processing-on-CPU">Process
<hr />
<h3><a name="CPU-filter-kernels" class="anchor" href="#CPU-filter-kernels">CPU filter kernels</a></h3>
<p>Filter kernels are used to call <code>applyFilter</code> function.
You can create 2D float32 array as new kernel or use implemented <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/global-kernels.html">kernels</a> such as:</p>
You can create 2D float32 array as new kernel or use implemented <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-kernels.html">kernels</a> such as:</p>
<ul>
<li>Gaussian Blur</li>
<li>Edges</li>
Expand All @@ -204,7 +204,7 @@ <h3><a name="CPU-filter-kernels" class="anchor" href="#CPU-filter-kernels">CPU f
</ul>
<h3><a name="Multi-threaded-processing-on-CPU" class="anchor" href="#Multi-threaded-processing-on-CPU">Multi-threaded processing on CPU</a></h3>
<p>You can use either single-threaded CPU-based image processing or multi-threaded image processing.
Multithreading is performed using logger and agent functions, which is specified in this <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/global-agents.html">section</a>.</p>
Multithreading is performed using logger and agent functions, which is specified in this <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-agents.html">section</a>.</p>
<p>Four of them are implemented:</p>
<ul>
<li>Logger, which is used to inform user about status of operations, i.e work of another agents</li>
Expand Down Expand Up @@ -246,7 +246,7 @@ <h2><a name="Processing-on-GPU" class="anchor" href="#Processing-on-GPU">Process
<hr />
<h3><a name="GPU-filter-kernels" class="anchor" href="#GPU-filter-kernels">GPU filter kernels</a></h3>
<p>Filter kernels are used to call <code>applyFilter</code> function.
You can create 2D float32 array as new kernel or use implemented <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/global-kernels.html">kernels</a> such as:</p>
You can create 2D float32 array as new kernel or use implemented <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-kernels.html">kernels</a> such as:</p>
<ul>
<li>Gaussian Blur</li>
<li>Edges</li>
Expand All @@ -257,7 +257,7 @@ <h3><a name="GPU-filter-kernels" class="anchor" href="#GPU-filter-kernels">GPU f
<h3><a name="GPU-processing-kernels" class="anchor" href="#GPU-processing-kernels">GPU processing kernels</a></h3>
<p>GPU kernels are used to call GPU-processing functions.
They have specific defining style, so for more information about how they work I recommended to visit <a href="https://yaccconstructor.github.io/Brahma.FSharp/Articles/Custom_Kernels.html">Brahma.Fsharp tutorial</a>.
But if you have no need in creating new GPU kernels just use implemented <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/global-gpu.html">ones</a>, such as:</p>
But if you have no need in creating new GPU kernels just use implemented <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-gpu.html">ones</a>, such as:</p>
<ul>
<li><code>applyFilterGPUKernel</code></li>
<li><code>rotateGPUKernel</code></li>
Expand All @@ -266,7 +266,7 @@ <h3><a name="GPU-processing-kernels" class="anchor" href="#GPU-processing-kernel
<p>All of them take <code>clContext</code> (which is device's environment abstraction) and <code>localWorkSize</code> (which shows the size of local work group) as input parameters.</p>
<h3><a name="Multi-threaded-processing-on-GPU" class="anchor" href="#Multi-threaded-processing-on-GPU">Multi-threaded processing on GPU</a></h3>
<p>You can use either single-threaded GPU-based image processing or multi-threaded image processing.
Multithreading is performed using logger and agent functions, which specified in this <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/global-agents.html">section</a>.</p>
Multithreading is performed using logger and agent functions, which specified in this <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-agents.html">section</a>.</p>
<p>Four of them are implemented:</p>
<ul>
<li>Logger, which is used to inform user about status of operations, i.e work of another agents</li>
Expand Down Expand Up @@ -325,14 +325,14 @@ <h2><a name="Processing-of-Multiple-Images-via-Directories" class="anchor" href=
<hr />
<h3><a name="Process-parameters" class="anchor" href="#Process-parameters">Process parameters</a></h3>
<p>The <code>processImage</code> function is designed to process directories with various configuration options.
It allows you to choose the type of <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html">agent support</a> for processing:</p>
It allows you to choose the type of <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-agentssupport.html">agent support</a> for processing:</p>
<ul>
<li><code>Full</code>, which uses a single agent for opening, processing and saving</li>
<li><code>Partial</code>, which uses different agents for each transformation and saving</li>
<li><code>PartialUsingComposition</code>, which uses one agent for transformation and one for saving</li>
<li><code>No</code>, which uses naive image processing function</li>
</ul>
<p>And define a list of <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/process-transformations.html">transformations</a> to apply to the image, and specify the <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/process-processingunits.html">processing unit</a> (CPU or GPU) for the operation.</p>
<p>And define a list of <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-transformations.html">transformations</a> to apply to the image, and specify the <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/process-processingunits.html">processing unit</a> (CPU or GPU) for the operation.</p>
<h3><a name="Simple-Directory-Processing-Example" class="anchor" href="#Simple-Directory-Processing-Example">Simple Directory Processing Example</a></h3>
<p>Open library and define directories:</p>
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">open</span> <span class="id">ImageProcessing</span><span class="pn">.</span><span class="id">Process</span>
Expand All @@ -341,10 +341,10 @@ <h3><a name="Simple-Directory-Processing-Example" class="anchor" href="#Simple-D
<span class="k">let</span> <span onmouseout="hideTip(event, 'fs14', 71)" onmouseover="showTip(event, 'fs14', 71)" class="id">inputDirectory</span> <span class="o">=</span> <span class="s">&quot;Full/Path/To/Input/Images/Folder/&quot;</span>
<span class="k">let</span> <span onmouseout="hideTip(event, 'fs15', 72)" onmouseover="showTip(event, 'fs15', 72)" class="id">outputDirectory</span> <span class="o">=</span> <span class="s">&quot;Full/Path/To/Output/Images/Folder/&quot;</span>
</code></pre>
<p>Define list of <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/process-transformations.html">transformations</a> and filters that will be used:</p>
<p>Define list of <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-transformations.html">transformations</a> and filters that will be used:</p>
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span onmouseout="hideTip(event, 'fs16', 73)" onmouseover="showTip(event, 'fs16', 73)" class="id">imageEditorsList</span> <span class="o">=</span> <span class="pn">[</span><span class="id">Darken</span><span class="pn">;</span> <span class="id">Edges</span><span class="pn">;</span> <span class="id">RotationL</span><span class="pn">]</span>
</code></pre>
<p>Note that transformations and filters will be applied sequentially, one-by-one on each image in the specific directory. Choose and define <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/process-processingunits.html#CPU">processing unit</a> and <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html">multithreading mode</a>.</p>
<p>Note that transformations and filters will be applied sequentially, one-by-one on each image in the specific directory. Choose and define <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-processingunits.html#CPU">processing unit</a> and <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-agentssupport.html">multithreading mode</a>.</p>
<pre class="fssnip highlighted"><code lang="fsharp"><span class="k">let</span> <span onmouseout="hideTip(event, 'fs17', 74)" onmouseover="showTip(event, 'fs17', 74)" class="id">processingUnit</span> <span class="o">=</span> <span class="id">GPU</span> <span class="id">Brahma</span><span class="pn">.</span><span class="id">FSharp</span><span class="pn">.</span><span class="id">Platform</span><span class="pn">.</span><span class="id">Nvidia</span>
<span class="k">let</span> <span onmouseout="hideTip(event, 'fs18', 75)" onmouseover="showTip(event, 'fs18', 75)" class="id">agentsSupport</span> <span class="o">=</span> <span class="id">AgentSupport</span><span class="pn">.</span><span class="id">Full</span>
</code></pre>
Expand Down
6 changes: 3 additions & 3 deletions docs/How_Tos/Using_A_CLI.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ <h3><a name="AgentsSupport" class="anchor" href="#AgentsSupport">AgentsSupport</
<ul>
<li><strong>Syntax:</strong> <code>-agent=&lt;agentType&gt;</code></li>
<li>
<strong>Description:</strong> Allows you to specify the <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html">agent strategy</a> to be used during image processing. You can choose from the following options:
<strong>Description:</strong> Allows you to specify the <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-agentssupport.html">agent strategy</a> to be used during image processing. You can choose from the following options:
<ul>
<li><code>Full</code>, which uses a single agent for opening, processing and saving</li>
<li><code>Partial</code>, which uses different agents for each transformation and saving</li>
Expand All @@ -173,7 +173,7 @@ <h3><a name="ProcessingUnit" class="anchor" href="#ProcessingUnit">ProcessingUni
<ul>
<li><strong>Syntax:</strong> <code>-unit=&lt;unitType&gt;</code></li>
<li>
<strong>Description:</strong> Specifies the <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/process-processingunits.html">processing unit</a> to be used for image processing. You can choose from the following options:
<strong>Description:</strong> Specifies the <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-processingunits.html">processing unit</a> to be used for image processing. You can choose from the following options:
<ul>
<li><code>CPU</code></li>
<li><code>NvidiaGPU</code></li>
Expand All @@ -187,7 +187,7 @@ <h3><a name="Transformations" class="anchor" href="#Transformations">Transformat
<ul>
<li><strong>Syntax:</strong> <code>&lt;transformation1&gt; &lt;transformation2&gt; ...</code></li>
<li>
<strong>Description:</strong> Provides a list of <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/process-transformations.html">available transformations</a> to be applied during image processing. You can choose from the following options:
<strong>Description:</strong> Provides a list of <a href="https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-transformations.html">available transformations</a> to be applied during image processing. You can choose from the following options:
<ul>
<li><code>Gauss</code></li>
<li><code>Sharpen</code></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/Tutorials/Getting_Started.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ <h3><a name="Package-Adding" class="anchor" href="#Package-Adding">Package Addin
<p>Go to directory with your <code>build.fsproj</code> (or <code>build.csproj</code>) file and install ImageProcessing using command line:</p>
<table class="pre"><tr><td class="snippet"><pre class="fssnip"><code lang="shell">dotnet add package ImageProcessing.PolinaSavelyeva --version 1.0.0
</code></pre></td></tr></table>
<p>For more information visit package main <a href="https://github.com/PolinaSavelyeva/ImageProcessing/pkgs/nuget/ImageProcessing">GitHub page</a>.</p>
<p>For more information visit package main <a href="https://github.com/PolinaSavelyeva/ImageProcessing/pkgs/nuget/ImageProcessing.PolinaSavelyeva">GitHub page</a>.</p>
<h2><a name="Features" class="anchor" href="#Features">Features</a></h2>
<hr />
<p>The following features are implemented, even for CPU and GPU:</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.json
View file

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions docsSrc/How_Tos/Making_A_Code.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ For detailed descriptions of all features visit [Api Reference](https://polinasa
### CPU filter kernels

Filter kernels are used to call ``applyFilter`` function.
You can create 2D float32 array as new kernel or use implemented [kernels](https://polinasavelyeva.github.io/ImageProcessing/reference/global-kernels.html) such as:
You can create 2D float32 array as new kernel or use implemented [kernels](https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-kernels.html) such as:

* Gaussian Blur
* Edges
Expand All @@ -63,7 +63,7 @@ You can create 2D float32 array as new kernel or use implemented [kernels](https
### Multi-threaded processing on CPU

You can use either single-threaded CPU-based image processing or multi-threaded image processing.
Multithreading is performed using logger and agent functions, which is specified in this [section](https://polinasavelyeva.github.io/ImageProcessing/reference/global-agents.html).
Multithreading is performed using logger and agent functions, which is specified in this [section](https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-agents.html).

Four of them are implemented:

Expand Down Expand Up @@ -120,7 +120,7 @@ applyCustomFilterOnCPU myImage pathToSave
### GPU filter kernels

Filter kernels are used to call ``applyFilter`` function.
You can create 2D float32 array as new kernel or use implemented [kernels](https://polinasavelyeva.github.io/ImageProcessing/reference/global-kernels.html) such as:
You can create 2D float32 array as new kernel or use implemented [kernels](https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-kernels.html) such as:

* Gaussian Blur
* Edges
Expand All @@ -132,7 +132,7 @@ You can create 2D float32 array as new kernel or use implemented [kernels](https

GPU kernels are used to call GPU-processing functions.
They have specific defining style, so for more information about how they work I recommended to visit [Brahma.Fsharp tutorial](https://yaccconstructor.github.io/Brahma.FSharp/Articles/Custom_Kernels.html).
But if you have no need in creating new GPU kernels just use implemented [ones](https://polinasavelyeva.github.io/ImageProcessing/reference/global-gpu.html), such as:
But if you have no need in creating new GPU kernels just use implemented [ones](https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-gpu.html), such as:

* ``applyFilterGPUKernel``
* ``rotateGPUKernel``
Expand All @@ -143,7 +143,7 @@ All of them take ``clContext`` (which is device's environment abstraction) and `
### Multi-threaded processing on GPU

You can use either single-threaded GPU-based image processing or multi-threaded image processing.
Multithreading is performed using logger and agent functions, which specified in this [section](https://polinasavelyeva.github.io/ImageProcessing/reference/global-agents.html).
Multithreading is performed using logger and agent functions, which specified in this [section](https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-agents.html).

Four of them are implemented:

Expand Down Expand Up @@ -223,14 +223,14 @@ applyCustomFilterOnGPU myImage pathToSave
### Process parameters

The ``processImage`` function is designed to process directories with various configuration options.
It allows you to choose the type of [agent support](https://polinasavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html) for processing:
It allows you to choose the type of [agent support](https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-agentssupport.html) for processing:

* ``Full``, which uses a single agent for opening, processing and saving
* ``Partial``, which uses different agents for each transformation and saving
* ``PartialUsingComposition``, which uses one agent for transformation and one for saving
* ``No``, which uses naive image processing function

And define a list of [transformations](https://polinasavelyeva.github.io/ImageProcessing/reference/process-transformations.html) to apply to the image, and specify the [processing unit](https://polinasavelyeva.github.io/ImageProcessing/reference/process-processingunits.html) (CPU or GPU) for the operation.
And define a list of [transformations](https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-transformations.html) to apply to the image, and specify the [processing unit](https://polinasavelyeva.github.io/ImageProcessing/reference/process-processingunits.html) (CPU or GPU) for the operation.

### Simple Directory Processing Example

Expand All @@ -244,13 +244,13 @@ let inputDirectory = "Full/Path/To/Input/Images/Folder/"
let outputDirectory = "Full/Path/To/Output/Images/Folder/"
```

Define list of [transformations](https://polinasavelyeva.github.io/ImageProcessing/reference/process-transformations.html) and filters that will be used:
Define list of [transformations](https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-transformations.html) and filters that will be used:

```fsharp
let imageEditorsList = [Darken; Edges; RotationL]
```

Note that transformations and filters will be applied sequentially, one-by-one on each image in the specific directory. Choose and define [processing unit](https://polinasavelyeva.github.io/ImageProcessing/reference/process-processingunits.html#CPU) and [multithreading mode](https://polinasavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html).
Note that transformations and filters will be applied sequentially, one-by-one on each image in the specific directory. Choose and define [processing unit](https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-processingunits.html#CPU) and [multithreading mode](https://polinasavelyeva.github.io/ImageProcessing/reference/imageprocessing-process-agentssupport.html).

```fsharp
let processingUnit = GPU Brahma.FSharp.Platform.Nvidia
Expand Down
Loading

0 comments on commit e196eba

Please sign in to comment.