diff --git a/README.md b/README.md index b42121a..95ddc0f 100644 --- a/README.md +++ b/README.md @@ -40,27 +40,29 @@ $ dotnet run -in /input/path -out /output/path -agent=no -unit=anygpu gauss sha ## Examples -The final result for all types of tranformations: +The final result for all types of transformations and filters: + |Original|Sharpen| |:-------|:------| -| ![image](https://github.com/PolinaSavelyeva/ImageProcessing/blob/main/resources/david-clode-78YxP3PP05A-unsplash2.jpg) | ![image](https://github.com/PolinaSavelyeva/ImageProcessing/blob/main/resources/david-clode-78YxP3PP05A-unsplashSharpen.jpg) | +| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplash2.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashSharpen.jpg) | |Gauss|Edges| |:-------|:------| -| ![image](https://github.com/PolinaSavelyeva/ImageProcessing/blob/main/resources/david-clode-78YxP3PP05A-unsplashGauss.jpg) | ![image](https://github.com/PolinaSavelyeva/ImageProcessing/blob/main/resources/david-clode-78YxP3PP05A-unsplashEdges.jpg) | +| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashGauss.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashEdges.jpg) | |Darken|Lighten| |:-------|:------| -| ![image](https://github.com/PolinaSavelyeva/ImageProcessing/blob/main/resources/david-clode-78YxP3PP05A-unsplashDarken.jpg) | ![image](https://github.com/PolinaSavelyeva/ImageProcessing/blob/main/resources/david-clode-78YxP3PP05A-unsplashLighten.jpg) | +| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashDarken.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashLighten.jpg) | |Rotation R|Rotation L| |:-------|:------| -| ![image](https://github.com/PolinaSavelyeva/ImageProcessing/blob/main/resources/david-clode-78YxP3PP05A-unsplashRotation.jpg) | ![image](https://github.com/PolinaSavelyeva/ImageProcessing/blob/main/resources/david-clode-78YxP3PP05A-unsplashRotationF.jpg) | +| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashRotation.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashRotationF.jpg) | |Flip H|Flip V| |:-------|:------| -| ![image](https://github.com/PolinaSavelyeva/ImageProcessing/blob/main/resources/david-clode-78YxP3PP05A-unsplashFlipF.jpg) | ![image](https://github.com/PolinaSavelyeva/ImageProcessing/blob/main/resources/david-clode-78YxP3PP05A-unsplashFlip.jpg) | +| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashFlipF.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashFlip.jpg) | + ### Template To find more building and running options take a look at the [MiniScaffold](https://github.com/TheAngryByrd/MiniScaffold) template. diff --git a/docs/Tutorials/Getting_Started.html b/docs/Tutorials/Getting_Started.html index d516bc8..eaac19c 100644 --- a/docs/Tutorials/Getting_Started.html +++ b/docs/Tutorials/Getting_Started.html @@ -142,18 +142,210 @@

Getting Started

-
open GPUImageProcessing
-let foo = ()
-let myAge = 21
-let color = Say.FavoriteColor.Red
-
-

Here is the path to downloading

-
paket install GPUImageProcessing
+
Prepearing

+
Requirements

+
First of all, make sure the following requirements are installed on your system:

+
+
To find more building and running options take a look at the MiniScaffold template.

+
Package Adding

+
Go to directory with your build.fsproj (or build.csproj) file and install ImageProcessing using command line:

+
dotnet add package ImageProcessing --version 1.0.0
+

+
For more information visit package main GitHub page.

+
Simple Usage

+
Using CLI

+
Before usage, go to specify directory:

+
$ cd /path/to/ImageProcessing/src/ImageProcessing
 

+
To process images from one directory and save them to another, you can use the following commands.

+
    
+
  • 
+#### Оne transformation applied to each image in the directory
+sh
+$ dotnet run -in /input/path -out /output/path -agent=full -unit=cpu gauss
+
    • 
+
  • 
+#### List of transformations that are sequentially applied
+sh
+$ dotnet run -in /input/path -out /output/path  -agent=no -unit=anygpu gauss sharpen
+More details about CLI processing you can find here.
+
    • 
+

+
Using Your Own Code

+
Open library and load image to process:

+
open ImageProcessing
+
+let myImage = MyImage.load ("Full/Path/To/Images/Folder/image_name.jpg")
+

+
Create new function which sequentially applies blur filter and clockwise rotation to images and saves it on CPU:

+
let applyCustomFilterOnCPU (image: MyImage) (pathToSave : string) = 
+    let blurredImage = image |> CPU.applyFilter gaussianBlurKernel
+    let rotatedImage = blurredImage |> CPU.rotate true
+    
+    MyImage.save rotatedImage pathToSave
+

+
Create the same function for GPU. But before it we need to do some steps for diagnosing graphical device.

+
Define the device value by specifying the brand of your GPU or whatever the program finds (embedded graphics cards are also suitable). And make OpenCL context of it:

+
let device = Brahma.FSharp.ClDevice.GetFirstAppropriateDevice()
+let clContext = Brahma.FSharp.ClContext(device)
+

+
Next, define new values for filter and rotation functions. This action is necessary because of compiling kernel function once:

+
let applyFilterGPU = GPU.applyFilter clContext 64
+let rotateGPU = GPU.rotate clContext 64
+

+
And the final function:

+
let applyCustomFilterOnGPU (image: MyImage) (pathToSave : string) = 
+    let blurredImage = image |> applyFilterGPU gaussianBlurKernel
+    let rotatedImage = blurredImage |> rotateGPU true
+    
+    MyImage.save rotatedImage pathToSave
+

+
The result:

+
open ImageProcessing
+
+let myImage = MyImage.load ("Full/Path/To/Images/Folder/image_name.jpg")
+
+let applyCustomFilterOnCPU (image: MyImage) (pathToSave : string) = 
+    let blurredImage = image |> CPU.applyFilter gaussianBlurKernel
+    let rotatedImage = blurredImage |> CPU.rotate true
+    
+    MyImage.save rotatedImage pathToSave
+
+let device = Brahma.FSharp.ClDevice.GetFirstAppropriateDevice()
+let clContext = Brahma.FSharp.ClContext(device)
+
+let applyCustomFilterOnGPU (image: MyImage) (pathToSave : string) = 
+    let blurredImage = image |> applyFilterGPU gaussianBlurKernel
+    let rotatedImage = blurredImage |> rotateGPU true
+    
+    MyImage.save rotatedImage pathToSave
+ 
+let pathToSave = "Path/To/Directory/image_name.jpg"
+applyCustomFilterOnCPU myImage pathToSave
+applyCustomFilterOnGPU myImage pathToSave
+

+
Features

+
The following features are implemented, even for CPU and GPU:

+
    
+
  • 
+Filters
+
      
+
    • Gaussian Blur
      • 
+
    • Edges
      • 
+
    • Sharpen
      • 
+
    • Lighten
      • 
+
    • Darken
      • 
+
    
+
    • 
+

+
    
+
  • 
+Transformations
+
      
+
    • Clockwise rotation
      • 
+
    • Counterclockwise rotation
      • 
+
    • Vertical flip (Y-axis)
      • 
+
    • Horizontal flip (X-axis)
      • 
+
    
+
    • 
+

+
    
+
  • 
+Multithreaded processing tools
+
      
+
    • Saving agent
      • 
+
    • Processing agent
      • 
+
    • Full processing agent, i.e saving plus processing
      • 
+
    • Events logger
      • 
+
    
+
    • 
+

+
    
+
  • Directory with pictures processing tool
    • 
+

+
For detailed descriptions of all features above visit Api Reference.

+
The final result for all types of transformations and filters:

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Original
Sharpen
image
image

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Gauss
Edges
image
image

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Darken
Lighten
image
image

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Rotation R
Rotation L
image
image

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Flip H
Flip V
image
image

+
 
-    
val foo: unit

-
val myAge: int

-
val color: obj

+    
Multiple items
val string: value: 'T -> string

--------------------
type string = System.String

 
 
 
diff --git a/docs/index.html b/docs/index.html
index b677e04..eb5e36e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -3,7 +3,7 @@
 
 
     
-    ImageProcessing
+    <title>Introduction to ImageProcessing
 
     
     
@@ -141,43 +141,50 @@
     
 
 

-    
ImageProcessing

+    
Introduction to ImageProcessing

 

 
What is ImageProcessing?

 
ImageProcessing is an easy-to-use F# package that utilizes Brahma.FSharp
 and SixLabors.ImageSharph. It offers two primary image processing options: CPU
 and GPU or agent-supported processing, all accessible within the included console application.

 
Why use ImageProcessing?

-
I created it because I had to solve an issue with this other thing.

+
It can helps you to process your images quickly using GPU or only command-line.

+
There is some of the features implemented in ImageProcessing.
+- Loading images from a local source and saving them.
+- Processing all images within a specified directory.
+- Filtering using one of five kernels, including "Gaussian blur" and "edges".
+- Other edits such as 90-degree rotation and flipping.
+- Combinations of existing transformations in four different scenarios.
+- Ability to utilize all of the features solely through the command line.

 

 

   

     

       

-        
Tutorials

-        
Takes you by the hand through a series of steps to create your first thing. 

+        
How-To make your own code

+        
Create new processing function using "bricks" via ImageProcessing. 

       

       

-        Get started
+        Get started
       

     

   

   

     

       

-        
How-To Guides

-        
Guides you through the steps involved in addressing key problems and use-cases. 

+        
How-To use CLI

+        
Quickly process your images using command line. 

       

       

-        Learn Usecases
+        Learn Usecases
       

     

   

   

     

       

-        
Explanations

-        
Discusses key topics and concepts at a fairly high level and provide useful background information and explanation..

+        
Library structure

+        
Helps you better understanding library's functions, modules and structures dependencies. 

       

       

         Dive Deeper
diff --git a/docs/index.json b/docs/index.json
index c97a5af..04a583d 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -1 +1 @@
-[{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global.html","title":"global","content":"Agents \nArguCommands \nCLI \nCPU \nGPU \nHelper \nKernels \nMyImage \nProcess"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-agents.html","title":"Agents","content":"Agents \n \nAgents.imageMessage \nimageMessage \nAgents.pathMessage \npathMessage \nAgents.logger \nlogger \nAgents.imageSaver \nimageSaver \nAgents.imageProcessor \nimageProcessor \nAgents.imageFullProcessor \nimageFullProcessor"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-agents.html#logger","title":"Agents.logger","content":"Agents.logger \nlogger \n\n Represents a logger, which receives messages and prints them\n to the console\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-agents.html#imageSaver","title":"Agents.imageSaver","content":"Agents.imageSaver \nimageSaver \n\n Defines an image saver agent that listens to image-messages and\n saves them to a specified output directory\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-agents.html#imageProcessor","title":"Agents.imageProcessor","content":"Agents.imageProcessor \nimageProcessor \n\n Defines an image processing agent that listens to image-messages and\n applies the given function\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-agents.html#imageFullProcessor","title":"Agents.imageFullProcessor","content":"Agents.imageFullProcessor \nimageFullProcessor \n\n Creates an image processing and saving MailboxProcessor that continuously receives path messages from\n an input mailbox. It loads, edits, and saves images to the specified output directory\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-imagemessage.html","title":"imageMessage","content":"imageMessage \n\n Represents a message type that can either contain an image or\n an end-of-stream signal, which is used with an asynchronous reply\n channel\n  \nimageMessage.Image \nImage \nimageMessage.EOS \nEOS"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-imagemessage.html#Image","title":"imageMessage.Image","content":"imageMessage.Image \nImage \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-imagemessage.html#EOS","title":"imageMessage.EOS","content":"imageMessage.EOS \nEOS \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-pathmessage.html","title":"pathMessage","content":"pathMessage \n\n Represents a message type encapsulated either a string path\n or an end-of-stream message, which is used with an asynchronous\n reply channel\n  \npathMessage.Path \nPath \npathMessage.EOS \nEOS"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-pathmessage.html#Path","title":"pathMessage.Path","content":"pathMessage.Path \nPath \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-pathmessage.html#EOS","title":"pathMessage.EOS","content":"pathMessage.EOS \nEOS \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-argucommands.html","title":"ArguCommands","content":"ArguCommands \n \nArguCommands.ArguProcessingUnits \nArguProcessingUnits \nArguCommands.CLIArguments \nCLIArguments \nArguCommands.arguProcessingUnitsParser \narguProcessingUnitsParser"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-argucommands.html#arguProcessingUnitsParser","title":"ArguCommands.arguProcessingUnitsParser","content":"ArguCommands.arguProcessingUnitsParser \narguProcessingUnitsParser \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html","title":"ArguProcessingUnits","content":"ArguProcessingUnits \n\n Represents the available CPU/GPU platforms for image processing\n  \nArguProcessingUnits.CPU \nCPU \nArguProcessingUnits.NvidiaGPU \nNvidiaGPU \nArguProcessingUnits.IntelGPU \nIntelGPU \nArguProcessingUnits.AmdGPU \nAmdGPU \nArguProcessingUnits.AnyGPU \nAnyGPU"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html#CPU","title":"ArguProcessingUnits.CPU","content":"ArguProcessingUnits.CPU \nCPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html#NvidiaGPU","title":"ArguProcessingUnits.NvidiaGPU","content":"ArguProcessingUnits.NvidiaGPU \nNvidiaGPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html#IntelGPU","title":"ArguProcessingUnits.IntelGPU","content":"ArguProcessingUnits.IntelGPU \nIntelGPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html#AmdGPU","title":"ArguProcessingUnits.AmdGPU","content":"ArguProcessingUnits.AmdGPU \nAmdGPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html#AnyGPU","title":"ArguProcessingUnits.AnyGPU","content":"ArguProcessingUnits.AnyGPU \nAnyGPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html","title":"CLIArguments","content":"CLIArguments \n \nCLIArguments.InputPath \nInputPath \nCLIArguments.OutputPath \nOutputPath \nCLIArguments.AgentsSupport \nAgentsSupport \nCLIArguments.ProcessingUnit \nProcessingUnit \nCLIArguments.Transformations \nTransformations"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html#InputPath","title":"CLIArguments.InputPath","content":"CLIArguments.InputPath \nInputPath \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html#OutputPath","title":"CLIArguments.OutputPath","content":"CLIArguments.OutputPath \nOutputPath \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html#AgentsSupport","title":"CLIArguments.AgentsSupport","content":"CLIArguments.AgentsSupport \nAgentsSupport \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html#ProcessingUnit","title":"CLIArguments.ProcessingUnit","content":"CLIArguments.ProcessingUnit \nProcessingUnit \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html#Transformations","title":"CLIArguments.Transformations","content":"CLIArguments.Transformations \nTransformations \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cli.html","title":"CLI","content":"CLI \n \nCLI.main \nmain"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cli.html#main","title":"CLI.main","content":"CLI.main \nmain \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cpu.html","title":"CPU","content":"CPU \n \nCPU.applyFilter \napplyFilter \nCPU.rotate \nrotate \nCPU.flip \nflip"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cpu.html#applyFilter","title":"CPU.applyFilter","content":"CPU.applyFilter \napplyFilter \n\n Applies a filter to an input image\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cpu.html#rotate","title":"CPU.rotate","content":"CPU.rotate \nrotate \n\n Rotates an input image either clockwise or counterclockwise\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cpu.html#flip","title":"CPU.flip","content":"CPU.flip \nflip \n\n Flips an input image either vertically or horizontally\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html","title":"GPU","content":"GPU \n \nGPU.applyFilterGPUKernel \napplyFilterGPUKernel \nGPU.rotateGPUKernel \nrotateGPUKernel \nGPU.flipGPUKernel \nflipGPUKernel \nGPU.applyFilter \napplyFilter \nGPU.rotate \nrotate \nGPU.flip \nflip"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#applyFilterGPUKernel","title":"GPU.applyFilterGPUKernel","content":"GPU.applyFilterGPUKernel \napplyFilterGPUKernel \n\n Creates compiled GPU filter kernel\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#rotateGPUKernel","title":"GPU.rotateGPUKernel","content":"GPU.rotateGPUKernel \nrotateGPUKernel \n\n Creates compiled GPU rotation kernel\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#flipGPUKernel","title":"GPU.flipGPUKernel","content":"GPU.flipGPUKernel \nflipGPUKernel \n\n Creates compiled GPU flip kernel\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#applyFilter","title":"GPU.applyFilter","content":"GPU.applyFilter \napplyFilter \n\n Applies a filter to the specified image using GPU\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#rotate","title":"GPU.rotate","content":"GPU.rotate \nrotate \n\n Rotates the image clockwise or counterclockwise using GPU\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#flip","title":"GPU.flip","content":"GPU.flip \nflip \n\n Flips the image vertically or horizontally using GPU\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-helper.html","title":"Helper","content":"Helper \n \nHelper.toFlatArray \ntoFlatArray \nHelper.generatePath \ngeneratePath"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-helper.html#toFlatArray","title":"Helper.toFlatArray","content":"Helper.toFlatArray \ntoFlatArray \n\n Converts a 2D array to a flat 1D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-helper.html#generatePath","title":"Helper.generatePath","content":"Helper.generatePath \ngeneratePath \n\n Generates a file path by combining an output directory and an image name\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html","title":"Kernels","content":"Kernels \n \nKernels.gaussianBlurKernel \ngaussianBlurKernel \nKernels.edgesKernel \nedgesKernel \nKernels.darkenKernel \ndarkenKernel \nKernels.lightenKernel \nlightenKernel \nKernels.sharpenKernel \nsharpenKernel"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html#gaussianBlurKernel","title":"Kernels.gaussianBlurKernel","content":"Kernels.gaussianBlurKernel \ngaussianBlurKernel \n\n Represents a Gaussian blur kernel for filter applying on CPU  as a 2D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html#edgesKernel","title":"Kernels.edgesKernel","content":"Kernels.edgesKernel \nedgesKernel \n\n Represents a edges kernel for filter applying on CPU as a 2D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html#darkenKernel","title":"Kernels.darkenKernel","content":"Kernels.darkenKernel \ndarkenKernel \n\n Represents a darken kernel for filter applying on CPU as a 2D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html#lightenKernel","title":"Kernels.lightenKernel","content":"Kernels.lightenKernel \nlightenKernel \n\n Represents a lighten kernel for filter applying on CPU as a 2D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html#sharpenKernel","title":"Kernels.sharpenKernel","content":"Kernels.sharpenKernel \nsharpenKernel \n\n Represents a sharpen kernel for filter applying on CPU as a 2D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-myimage.html","title":"MyImage","content":"MyImage \n \nMyImage.MyImage \nMyImage \nMyImage.load \nload \nMyImage.save \nsave"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-myimage.html#load","title":"MyImage.load","content":"MyImage.load \nload \n\n Loads the image located at the specified file path\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-myimage.html#save","title":"MyImage.save","content":"MyImage.save \nsave \n\n Saves the image to the specified directory in the same extension as the input\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html","title":"MyImage","content":"MyImage \n\n Encapsulates an image, which includes both the byte pixel data and its associated attributes.\n  \nMyImage.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nMyImage.Data \nData \nMyImage.Width \nWidth \nMyImage.Height \nHeight \nMyImage.Name \nName"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html#\u0060\u0060.ctor\u0060\u0060","title":"MyImage.\u0060\u0060.ctor\u0060\u0060","content":"MyImage.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html#Data","title":"MyImage.Data","content":"MyImage.Data \nData \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html#Width","title":"MyImage.Width","content":"MyImage.Width \nWidth \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html#Height","title":"MyImage.Height","content":"MyImage.Height \nHeight \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html#Name","title":"MyImage.Name","content":"MyImage.Name \nName \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-process.html","title":"Process","content":"Process \n \nProcess.AgentsSupport \nAgentsSupport \nProcess.ProcessingUnits \nProcessingUnits \nProcess.Transformations \nTransformations \nProcess.transformationsParserCPU \ntransformationsParserCPU \nProcess.transformationsParserGPU \ntransformationsParserGPU \nProcess.processImages \nprocessImages"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-process.html#transformationsParserCPU","title":"Process.transformationsParserCPU","content":"Process.transformationsParserCPU \ntransformationsParserCPU \n\n Parses an image transformation and returns the corresponding CPU-based transformation function\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-process.html#transformationsParserGPU","title":"Process.transformationsParserGPU","content":"Process.transformationsParserGPU \ntransformationsParserGPU \n\n Generates GPU kernel functions for applying various image transformations\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-process.html#processImages","title":"Process.processImages","content":"Process.processImages \nprocessImages \n\n Processes images located at the specified input path and saves the processed images to the specified output path\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html","title":"AgentsSupport","content":"AgentsSupport \n\n Specifies the level of agents support\n  \nAgentsSupport.Full \nFull \nAgentsSupport.Partial \nPartial \nAgentsSupport.PartialUsingComposition \nPartialUsingComposition \nAgentsSupport.No \nNo"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html#Full","title":"AgentsSupport.Full","content":"AgentsSupport.Full \nFull \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html#Partial","title":"AgentsSupport.Partial","content":"AgentsSupport.Partial \nPartial \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html#PartialUsingComposition","title":"AgentsSupport.PartialUsingComposition","content":"AgentsSupport.PartialUsingComposition \nPartialUsingComposition \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html#No","title":"AgentsSupport.No","content":"AgentsSupport.No \nNo \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-processingunits.html","title":"ProcessingUnits","content":"ProcessingUnits \n\n Represents processing device\n  \nProcessingUnits.CPU \nCPU \nProcessingUnits.GPU \nGPU"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-processingunits.html#CPU","title":"ProcessingUnits.CPU","content":"ProcessingUnits.CPU \nCPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-processingunits.html#GPU","title":"ProcessingUnits.GPU","content":"ProcessingUnits.GPU \nGPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html","title":"Transformations","content":"Transformations \n\n Represents the available image transformations\n  \nTransformations.Gauss \nGauss \nTransformations.Sharpen \nSharpen \nTransformations.Lighten \nLighten \nTransformations.Darken \nDarken \nTransformations.Edges \nEdges \nTransformations.RotationR \nRotationR \nTransformations.RotationL \nRotationL \nTransformations.FlipV \nFlipV \nTransformations.FlipH \nFlipH"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#Gauss","title":"Transformations.Gauss","content":"Transformations.Gauss \nGauss \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#Sharpen","title":"Transformations.Sharpen","content":"Transformations.Sharpen \nSharpen \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#Lighten","title":"Transformations.Lighten","content":"Transformations.Lighten \nLighten \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#Darken","title":"Transformations.Darken","content":"Transformations.Darken \nDarken \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#Edges","title":"Transformations.Edges","content":"Transformations.Edges \nEdges \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#RotationR","title":"Transformations.RotationR","content":"Transformations.RotationR \nRotationR \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#RotationL","title":"Transformations.RotationL","content":"Transformations.RotationL \nRotationL \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#FlipV","title":"Transformations.FlipV","content":"Transformations.FlipV \nFlipV \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#FlipH","title":"Transformations.FlipH","content":"Transformations.FlipH \nFlipH \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/index.html","title":"ImageProcessing\r\n","content":"# ImageProcessing\r\n\r\n---\r\n\r\n## What is ImageProcessing?\r\n\r\nImageProcessing is an easy-to-use F# package that utilizes [Brahma.FSharp](https://github.com/YaccConstructor/Brahma.FSharp)\r\nand [SixLabors.ImageSharph](https://github.com/SixLabors/ImageSharp). It offers two primary image processing options: CPU\r\nand GPU or agent-supported processing, all accessible within the included console application.\r\n\r\n## Why use ImageProcessing?\r\n\r\nI created it because I had to solve an issue with this other thing.\r\n\r\n---\r\n\r\n\u003Cdiv class=\u0022row row-cols-1 row-cols-md-2\u0022\u003E\r\n  \u003Cdiv class=\u0022col mb-4\u0022\u003E\r\n    \u003Cdiv class=\u0022card h-100\u0022\u003E\r\n      \u003Cdiv class=\u0022card-body\u0022\u003E\r\n        \u003Ch5 class=\u0022card-title\u0022\u003ETutorials\u003C/h5\u003E\r\n        \u003Cp class=\u0022card-text\u0022\u003ETakes you by the hand through a series of steps to create your first thing. \u003C/p\u003E\r\n      \u003C/div\u003E\r\n      \u003Cdiv class=\u0022card-footer text-right   border-top-0\u0022\u003E\r\n        \u003Ca href=\u0022{{root}}Tutorials/Getting_Started.html\u0022 class=\u0022btn btn-primary\u0022\u003EGet started\u003C/a\u003E\r\n      \u003C/div\u003E\r\n    \u003C/div\u003E\r\n  \u003C/div\u003E\r\n  \u003Cdiv class=\u0022col mb-4\u0022\u003E\r\n    \u003Cdiv class=\u0022card h-100\u0022\u003E\r\n      \u003Cdiv class=\u0022card-body\u0022\u003E\r\n        \u003Ch5 class=\u0022card-title\u0022\u003EHow-To Guides\u003C/h5\u003E\r\n        \u003Cp class=\u0022card-text\u0022\u003EGuides you through the steps involved in addressing key problems and use-cases. \u003C/p\u003E\r\n      \u003C/div\u003E\r\n      \u003Cdiv class=\u0022card-footer text-right   border-top-0\u0022\u003E\r\n        \u003Ca href=\u0022{{root}}How_Tos/Doing_A_Thing.html\u0022 class=\u0022btn btn-primary\u0022\u003ELearn Usecases\u003C/a\u003E\r\n      \u003C/div\u003E\r\n    \u003C/div\u003E\r\n  \u003C/div\u003E\r\n  \u003Cdiv class=\u0022col mb-4 mb-md-0\u0022\u003E\r\n    \u003Cdiv class=\u0022card h-100\u0022\u003E\r\n      \u003Cdiv class=\u0022card-body\u0022\u003E\r\n        \u003Ch5 class=\u0022card-title\u0022\u003EExplanations\u003C/h5\u003E\r\n        \u003Cp class=\u0022card-text\u0022\u003EDiscusses key topics and concepts at a fairly high level and provide useful background information and explanation..\u003C/p\u003E\r\n      \u003C/div\u003E\r\n      \u003Cdiv class=\u0022card-footer text-right   border-top-0\u0022\u003E\r\n        \u003Ca href=\u0022{{root}}Explanations/Background.html\u0022 class=\u0022btn btn-primary\u0022\u003EDive Deeper\u003C/a\u003E\r\n      \u003C/div\u003E\r\n    \u003C/div\u003E\r\n  \u003C/div\u003E\r\n  \u003Cdiv class=\u0022col\u0022\u003E\r\n    \u003Cdiv class=\u0022card h-100\u0022\u003E\r\n      \u003Cdiv class=\u0022card-body\u0022\u003E\r\n        \u003Ch5 class=\u0022card-title\u0022\u003EApi Reference\u003C/h5\u003E\r\n        \u003Cp class=\u0022card-text\u0022\u003EContain technical reference for APIs.\u003C/p\u003E\r\n      \u003C/div\u003E\r\n      \u003Cdiv class=\u0022card-footer text-right   border-top-0\u0022\u003E\r\n        \u003Ca href=\u0022{{root}}reference/index.html\u0022 class=\u0022btn btn-primary\u0022\u003ERead Api Docs\u003C/a\u003E\r\n      \u003C/div\u003E\r\n    \u003C/div\u003E\r\n  \u003C/div\u003E\r\n\u003C/div\u003E\r\n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/Explanations/Background.html","title":"Background","content":"---\r\ntitle: Background\r\ncategory: Explanations\r\ncategoryindex: 3\r\nindex: 1\r\n---\r\n\r\n# Background\r\n\r\nHere\u0027s a core concept and reasons why this exists at a deeper level. CHECK\r\n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/How_Tos/Doing_Another_Thing.html","title":"How To do a second thing","content":"---\r\ntitle: How To do a second thing\r\ncategory: How To Guides\r\ncategoryindex: 2\r\nindex: 2\r\n---\r\n\r\n# How To do a second thing\r\n\r\n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/How_Tos/Doing_A_Thing.html","title":"How To do a first thing","content":"---\r\ntitle: How To do a first thing\r\ncategory: How To Guides\r\ncategoryindex: 2\r\nindex: 1\r\n---\r\n\r\n# How To do a first thing\r\n\r\n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/Tutorials/Getting_Started.html","title":"Getting Started","content":"---\r\ntitle: Getting Started\r\ncategory: Tutorials\r\ncategoryindex: 1\r\nindex: 1\r\n---\r\n\r\n# Getting Started\r\n\r\n\u0060\u0060\u0060fsharp\r\nopen GPUImageProcessing\r\nlet foo = ()\r\nlet myAge = 21\r\nlet color = Say.FavoriteColor.Red\r\n\u0060\u0060\u0060\r\n\r\n## Here is the path to downloading\r\n\r\n    [lang=bash]\r\n    paket install GPUImageProcessing\r\n\r\n\r\n"}]
\ No newline at end of file
+[{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global.html","title":"global","content":"Agents \nArguCommands \nCLI \nCPU \nGPU \nHelper \nKernels \nMyImage \nProcess"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-agents.html","title":"Agents","content":"Agents \n \nAgents.imageMessage \nimageMessage \nAgents.pathMessage \npathMessage \nAgents.logger \nlogger \nAgents.imageSaver \nimageSaver \nAgents.imageProcessor \nimageProcessor \nAgents.imageFullProcessor \nimageFullProcessor"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-agents.html#logger","title":"Agents.logger","content":"Agents.logger \nlogger \n\n Represents a logger, which receives messages and prints them\n to the console\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-agents.html#imageSaver","title":"Agents.imageSaver","content":"Agents.imageSaver \nimageSaver \n\n Defines an image saver agent that listens to image-messages and\n saves them to a specified output directory\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-agents.html#imageProcessor","title":"Agents.imageProcessor","content":"Agents.imageProcessor \nimageProcessor \n\n Defines an image processing agent that listens to image-messages and\n applies the given function\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-agents.html#imageFullProcessor","title":"Agents.imageFullProcessor","content":"Agents.imageFullProcessor \nimageFullProcessor \n\n Creates an image processing and saving MailboxProcessor that continuously receives path messages from\n an input mailbox. It loads, edits, and saves images to the specified output directory\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-imagemessage.html","title":"imageMessage","content":"imageMessage \n\n Represents a message type that can either contain an image or\n an end-of-stream signal, which is used with an asynchronous reply\n channel\n  \nimageMessage.Image \nImage \nimageMessage.EOS \nEOS"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-imagemessage.html#Image","title":"imageMessage.Image","content":"imageMessage.Image \nImage \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-imagemessage.html#EOS","title":"imageMessage.EOS","content":"imageMessage.EOS \nEOS \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-pathmessage.html","title":"pathMessage","content":"pathMessage \n\n Represents a message type encapsulated either a string path\n or an end-of-stream message, which is used with an asynchronous\n reply channel\n  \npathMessage.Path \nPath \npathMessage.EOS \nEOS"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-pathmessage.html#Path","title":"pathMessage.Path","content":"pathMessage.Path \nPath \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/agents-pathmessage.html#EOS","title":"pathMessage.EOS","content":"pathMessage.EOS \nEOS \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-argucommands.html","title":"ArguCommands","content":"ArguCommands \n \nArguCommands.ArguProcessingUnits \nArguProcessingUnits \nArguCommands.CLIArguments \nCLIArguments \nArguCommands.arguProcessingUnitsParser \narguProcessingUnitsParser"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-argucommands.html#arguProcessingUnitsParser","title":"ArguCommands.arguProcessingUnitsParser","content":"ArguCommands.arguProcessingUnitsParser \narguProcessingUnitsParser \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html","title":"ArguProcessingUnits","content":"ArguProcessingUnits \n\n Represents the available CPU/GPU platforms for image processing\n  \nArguProcessingUnits.CPU \nCPU \nArguProcessingUnits.NvidiaGPU \nNvidiaGPU \nArguProcessingUnits.IntelGPU \nIntelGPU \nArguProcessingUnits.AmdGPU \nAmdGPU \nArguProcessingUnits.AnyGPU \nAnyGPU"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html#CPU","title":"ArguProcessingUnits.CPU","content":"ArguProcessingUnits.CPU \nCPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html#NvidiaGPU","title":"ArguProcessingUnits.NvidiaGPU","content":"ArguProcessingUnits.NvidiaGPU \nNvidiaGPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html#IntelGPU","title":"ArguProcessingUnits.IntelGPU","content":"ArguProcessingUnits.IntelGPU \nIntelGPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html#AmdGPU","title":"ArguProcessingUnits.AmdGPU","content":"ArguProcessingUnits.AmdGPU \nAmdGPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-arguprocessingunits.html#AnyGPU","title":"ArguProcessingUnits.AnyGPU","content":"ArguProcessingUnits.AnyGPU \nAnyGPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html","title":"CLIArguments","content":"CLIArguments \n \nCLIArguments.InputPath \nInputPath \nCLIArguments.OutputPath \nOutputPath \nCLIArguments.AgentsSupport \nAgentsSupport \nCLIArguments.ProcessingUnit \nProcessingUnit \nCLIArguments.Transformations \nTransformations"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html#InputPath","title":"CLIArguments.InputPath","content":"CLIArguments.InputPath \nInputPath \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html#OutputPath","title":"CLIArguments.OutputPath","content":"CLIArguments.OutputPath \nOutputPath \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html#AgentsSupport","title":"CLIArguments.AgentsSupport","content":"CLIArguments.AgentsSupport \nAgentsSupport \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html#ProcessingUnit","title":"CLIArguments.ProcessingUnit","content":"CLIArguments.ProcessingUnit \nProcessingUnit \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/argucommands-cliarguments.html#Transformations","title":"CLIArguments.Transformations","content":"CLIArguments.Transformations \nTransformations \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cli.html","title":"CLI","content":"CLI \n \nCLI.main \nmain"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cli.html#main","title":"CLI.main","content":"CLI.main \nmain \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cpu.html","title":"CPU","content":"CPU \n \nCPU.applyFilter \napplyFilter \nCPU.rotate \nrotate \nCPU.flip \nflip"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cpu.html#applyFilter","title":"CPU.applyFilter","content":"CPU.applyFilter \napplyFilter \n\n Applies a filter to an input image\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cpu.html#rotate","title":"CPU.rotate","content":"CPU.rotate \nrotate \n\n Rotates an input image either clockwise or counterclockwise\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-cpu.html#flip","title":"CPU.flip","content":"CPU.flip \nflip \n\n Flips an input image either vertically or horizontally\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html","title":"GPU","content":"GPU \n \nGPU.applyFilterGPUKernel \napplyFilterGPUKernel \nGPU.rotateGPUKernel \nrotateGPUKernel \nGPU.flipGPUKernel \nflipGPUKernel \nGPU.applyFilter \napplyFilter \nGPU.rotate \nrotate \nGPU.flip \nflip"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#applyFilterGPUKernel","title":"GPU.applyFilterGPUKernel","content":"GPU.applyFilterGPUKernel \napplyFilterGPUKernel \n\n Creates compiled GPU filter kernel\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#rotateGPUKernel","title":"GPU.rotateGPUKernel","content":"GPU.rotateGPUKernel \nrotateGPUKernel \n\n Creates compiled GPU rotation kernel\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#flipGPUKernel","title":"GPU.flipGPUKernel","content":"GPU.flipGPUKernel \nflipGPUKernel \n\n Creates compiled GPU flip kernel\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#applyFilter","title":"GPU.applyFilter","content":"GPU.applyFilter \napplyFilter \n\n Applies a filter to the specified image using GPU\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#rotate","title":"GPU.rotate","content":"GPU.rotate \nrotate \n\n Rotates the image clockwise or counterclockwise using GPU\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-gpu.html#flip","title":"GPU.flip","content":"GPU.flip \nflip \n\n Flips the image vertically or horizontally using GPU\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-helper.html","title":"Helper","content":"Helper \n \nHelper.toFlatArray \ntoFlatArray \nHelper.generatePath \ngeneratePath"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-helper.html#toFlatArray","title":"Helper.toFlatArray","content":"Helper.toFlatArray \ntoFlatArray \n\n Converts a 2D array to a flat 1D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-helper.html#generatePath","title":"Helper.generatePath","content":"Helper.generatePath \ngeneratePath \n\n Generates a file path by combining an output directory and an image name\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html","title":"Kernels","content":"Kernels \n \nKernels.gaussianBlurKernel \ngaussianBlurKernel \nKernels.edgesKernel \nedgesKernel \nKernels.darkenKernel \ndarkenKernel \nKernels.lightenKernel \nlightenKernel \nKernels.sharpenKernel \nsharpenKernel"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html#gaussianBlurKernel","title":"Kernels.gaussianBlurKernel","content":"Kernels.gaussianBlurKernel \ngaussianBlurKernel \n\n Represents a Gaussian blur kernel for filter applying on CPU  as a 2D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html#edgesKernel","title":"Kernels.edgesKernel","content":"Kernels.edgesKernel \nedgesKernel \n\n Represents a edges kernel for filter applying on CPU as a 2D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html#darkenKernel","title":"Kernels.darkenKernel","content":"Kernels.darkenKernel \ndarkenKernel \n\n Represents a darken kernel for filter applying on CPU as a 2D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html#lightenKernel","title":"Kernels.lightenKernel","content":"Kernels.lightenKernel \nlightenKernel \n\n Represents a lighten kernel for filter applying on CPU as a 2D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-kernels.html#sharpenKernel","title":"Kernels.sharpenKernel","content":"Kernels.sharpenKernel \nsharpenKernel \n\n Represents a sharpen kernel for filter applying on CPU as a 2D array\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-myimage.html","title":"MyImage","content":"MyImage \n \nMyImage.MyImage \nMyImage \nMyImage.load \nload \nMyImage.save \nsave"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-myimage.html#load","title":"MyImage.load","content":"MyImage.load \nload \n\n Loads the image located at the specified file path\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-myimage.html#save","title":"MyImage.save","content":"MyImage.save \nsave \n\n Saves the image to the specified directory in the same extension as the input\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html","title":"MyImage","content":"MyImage \n\n Encapsulates an image, which includes both the byte pixel data and its associated attributes.\n  \nMyImage.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \nMyImage.Data \nData \nMyImage.Width \nWidth \nMyImage.Height \nHeight \nMyImage.Name \nName"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html#\u0060\u0060.ctor\u0060\u0060","title":"MyImage.\u0060\u0060.ctor\u0060\u0060","content":"MyImage.\u0060\u0060.ctor\u0060\u0060 \n\u0060\u0060.ctor\u0060\u0060 \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html#Data","title":"MyImage.Data","content":"MyImage.Data \nData \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html#Width","title":"MyImage.Width","content":"MyImage.Width \nWidth \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html#Height","title":"MyImage.Height","content":"MyImage.Height \nHeight \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/myimage-myimage.html#Name","title":"MyImage.Name","content":"MyImage.Name \nName \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-process.html","title":"Process","content":"Process \n \nProcess.AgentsSupport \nAgentsSupport \nProcess.ProcessingUnits \nProcessingUnits \nProcess.Transformations \nTransformations \nProcess.transformationsParserCPU \ntransformationsParserCPU \nProcess.transformationsParserGPU \ntransformationsParserGPU \nProcess.processImages \nprocessImages"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-process.html#transformationsParserCPU","title":"Process.transformationsParserCPU","content":"Process.transformationsParserCPU \ntransformationsParserCPU \n\n Parses an image transformation and returns the corresponding CPU-based transformation function\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-process.html#transformationsParserGPU","title":"Process.transformationsParserGPU","content":"Process.transformationsParserGPU \ntransformationsParserGPU \n\n Generates GPU kernel functions for applying various image transformations\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/global-process.html#processImages","title":"Process.processImages","content":"Process.processImages \nprocessImages \n\n Processes images located at the specified input path and saves the processed images to the specified output path\n "},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html","title":"AgentsSupport","content":"AgentsSupport \n\n Specifies the level of agents support\n  \nAgentsSupport.Full \nFull \nAgentsSupport.Partial \nPartial \nAgentsSupport.PartialUsingComposition \nPartialUsingComposition \nAgentsSupport.No \nNo"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html#Full","title":"AgentsSupport.Full","content":"AgentsSupport.Full \nFull \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html#Partial","title":"AgentsSupport.Partial","content":"AgentsSupport.Partial \nPartial \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html#PartialUsingComposition","title":"AgentsSupport.PartialUsingComposition","content":"AgentsSupport.PartialUsingComposition \nPartialUsingComposition \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-agentssupport.html#No","title":"AgentsSupport.No","content":"AgentsSupport.No \nNo \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-processingunits.html","title":"ProcessingUnits","content":"ProcessingUnits \n\n Represents processing device\n  \nProcessingUnits.CPU \nCPU \nProcessingUnits.GPU \nGPU"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-processingunits.html#CPU","title":"ProcessingUnits.CPU","content":"ProcessingUnits.CPU \nCPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-processingunits.html#GPU","title":"ProcessingUnits.GPU","content":"ProcessingUnits.GPU \nGPU \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html","title":"Transformations","content":"Transformations \n\n Represents the available image transformations\n  \nTransformations.Gauss \nGauss \nTransformations.Sharpen \nSharpen \nTransformations.Lighten \nLighten \nTransformations.Darken \nDarken \nTransformations.Edges \nEdges \nTransformations.RotationR \nRotationR \nTransformations.RotationL \nRotationL \nTransformations.FlipV \nFlipV \nTransformations.FlipH \nFlipH"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#Gauss","title":"Transformations.Gauss","content":"Transformations.Gauss \nGauss \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#Sharpen","title":"Transformations.Sharpen","content":"Transformations.Sharpen \nSharpen \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#Lighten","title":"Transformations.Lighten","content":"Transformations.Lighten \nLighten \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#Darken","title":"Transformations.Darken","content":"Transformations.Darken \nDarken \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#Edges","title":"Transformations.Edges","content":"Transformations.Edges \nEdges \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#RotationR","title":"Transformations.RotationR","content":"Transformations.RotationR \nRotationR \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#RotationL","title":"Transformations.RotationL","content":"Transformations.RotationL \nRotationL \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#FlipV","title":"Transformations.FlipV","content":"Transformations.FlipV \nFlipV \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/reference/process-transformations.html#FlipH","title":"Transformations.FlipH","content":"Transformations.FlipH \nFlipH \n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/index.html","title":"Introduction to ImageProcessing\r\n","content":"# Introduction to ImageProcessing\n\n---\n\n## What is ImageProcessing?\n\nImageProcessing is an easy-to-use F# package that utilizes [Brahma.FSharp](https://github.com/YaccConstructor/Brahma.FSharp)\nand [SixLabors.ImageSharph](https://github.com/SixLabors/ImageSharp). It offers two primary image processing options: CPU\nand GPU or agent-supported processing, all accessible within the included console application.\n\n## Why use ImageProcessing?\n\nIt can helps you to process your images quickly using GPU or only command-line. \n\nThere is some of the features implemented in ImageProcessing.\n- Loading images from a local source and saving them.\n- Processing all images within a specified directory.\n- Filtering using one of five kernels, including \u0022Gaussian blur\u0022 and \u0022edges\u0022.\n- Other edits such as 90-degree rotation and flipping.\n- Combinations of existing transformations in four different scenarios.\n- Ability to utilize all of the features solely through the command line.\n\n---\n\n\u003Cdiv class=\u0022row row-cols-1 row-cols-md-2\u0022\u003E\n  \u003Cdiv class=\u0022col mb-4\u0022\u003E\n    \u003Cdiv class=\u0022card h-100\u0022\u003E\n      \u003Cdiv class=\u0022card-body\u0022\u003E\n        \u003Ch5 class=\u0022card-title\u0022\u003EHow-To make your own code\u003C/h5\u003E\n        \u003Cp class=\u0022card-text\u0022\u003ECreate new processing function using \u0022bricks\u0022 via ImageProcessing. \u003C/p\u003E\n      \u003C/div\u003E\n      \u003Cdiv class=\u0022card-footer text-right   border-top-0\u0022\u003E\n        \u003Ca href=\u0022{{root}}How-Tos/Doing_A_Thing.html\u0022 class=\u0022btn btn-primary\u0022\u003EGet started\u003C/a\u003E\n      \u003C/div\u003E\n    \u003C/div\u003E\n  \u003C/div\u003E\n  \u003Cdiv class=\u0022col mb-4\u0022\u003E\n    \u003Cdiv class=\u0022card h-100\u0022\u003E\n      \u003Cdiv class=\u0022card-body\u0022\u003E\n        \u003Ch5 class=\u0022card-title\u0022\u003EHow-To use CLI\u003C/h5\u003E\n        \u003Cp class=\u0022card-text\u0022\u003EQuickly process your images using command line. \u003C/p\u003E\n      \u003C/div\u003E\n      \u003Cdiv class=\u0022card-footer text-right   border-top-0\u0022\u003E\n        \u003Ca href=\u0022{{root}}How_Tos/Doing_Another_Thing.html\u0022 class=\u0022btn btn-primary\u0022\u003ELearn Usecases\u003C/a\u003E\n      \u003C/div\u003E\n    \u003C/div\u003E\n  \u003C/div\u003E\n  \u003Cdiv class=\u0022col mb-4 mb-md-0\u0022\u003E\n    \u003Cdiv class=\u0022card h-100\u0022\u003E\n      \u003Cdiv class=\u0022card-body\u0022\u003E\n        \u003Ch5 class=\u0022card-title\u0022\u003ELibrary structure\u003C/h5\u003E\n        \u003Cp class=\u0022card-text\u0022\u003EHelps you better understanding library\u0027s functions, modules and structures dependencies. \u003C/p\u003E\n      \u003C/div\u003E\n      \u003Cdiv class=\u0022card-footer text-right   border-top-0\u0022\u003E\n        \u003Ca href=\u0022{{root}}Explanations/Background.html\u0022 class=\u0022btn btn-primary\u0022\u003EDive Deeper\u003C/a\u003E\n      \u003C/div\u003E\n    \u003C/div\u003E\n  \u003C/div\u003E\n  \u003Cdiv class=\u0022col\u0022\u003E\n    \u003Cdiv class=\u0022card h-100\u0022\u003E\n      \u003Cdiv class=\u0022card-body\u0022\u003E\n        \u003Ch5 class=\u0022card-title\u0022\u003EApi Reference\u003C/h5\u003E\n        \u003Cp class=\u0022card-text\u0022\u003EContain technical reference for APIs.\u003C/p\u003E\n      \u003C/div\u003E\n      \u003Cdiv class=\u0022card-footer text-right   border-top-0\u0022\u003E\n        \u003Ca href=\u0022{{root}}reference/index.html\u0022 class=\u0022btn btn-primary\u0022\u003ERead Api Docs\u003C/a\u003E\n      \u003C/div\u003E\n    \u003C/div\u003E\n  \u003C/div\u003E\n\u003C/div\u003E\n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/Explanations/Background.html","title":"Background","content":"---\r\ntitle: Background\r\ncategory: Explanations\r\ncategoryindex: 3\r\nindex: 1\r\n---\r\n\r\n# Background\r\n\r\nHere\u0027s a core concept and reasons why this exists at a deeper level. CHECK\r\n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/How_Tos/Doing_Another_Thing.html","title":"How To do a second thing","content":"---\r\ntitle: How To do a second thing\r\ncategory: How To Guides\r\ncategoryindex: 2\r\nindex: 2\r\n---\r\n\r\n# How To do a second thing\r\n\r\n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/How_Tos/Doing_A_Thing.html","title":"How To do a first thing","content":"---\r\ntitle: How To do a first thing\r\ncategory: How To Guides\r\ncategoryindex: 2\r\nindex: 1\r\n---\r\n\r\n# How To do a first thing\r\n\r\n"},{"uri":"https://PolinaSavelyeva.github.io/ImageProcessing/Tutorials/Getting_Started.html","title":"Getting Started","content":"---\ntitle: Getting Started\ncategory: Tutorials\ncategoryindex: 1\nindex: 1\n---\n\n# Getting Started\n\n## Prepearing\n\n### Requirements\n\nFirst of all, make sure the following requirements are installed on your system:\n\n- [dotnet SDK](https://www.microsoft.com/net/download/core) 3.0 or higher (recommended 6.0\u002B),\n- [Mono](http://www.mono-project.com/) if you\u0027re on Linux or macOS or\n- [VSCode Dev Container](https://code.visualstudio.com/docs/remote/containers).\n\nTo find more building and running options take a look at the [MiniScaffold](https://github.com/TheAngryByrd/MiniScaffold) template.\n\n### Package Adding\n\nGo to directory with your \u0060\u0060build.fsproj\u0060\u0060 (or \u0060\u0060build.csproj\u0060\u0060) file and install ImageProcessing using command line:\n\n    [lang=bash]\n    dotnet add package ImageProcessing --version 1.0.0\n\nFor more information visit package main [GitHub page](https://github.com/PolinaSavelyeva/ImageProcessing/pkgs/nuget/ImageProcessing).\n\n## Simple Usage\n\n### Using CLI\nBefore usage, go to specify directory:\n\u0060\u0060\u0060sh\n$ cd /path/to/ImageProcessing/src/ImageProcessing\n\u0060\u0060\u0060\nTo process images from one directory and save them to another, you can use the following commands.\n\n- #### \u041Ene transformation applied to each image in the directory\n\u0060\u0060\u0060sh\n$ dotnet run -in /input/path -out /output/path -agent=full -unit=cpu gauss\n\u0060\u0060\u0060\n- #### List of transformations that are sequentially applied\n\u0060\u0060\u0060sh\n$ dotnet run -in /input/path -out /output/path  -agent=no -unit=anygpu gauss sharpen\n\u0060\u0060\u0060\nMore details about CLI processing you can find [here]().\n\n### Using Your Own Code\n\nOpen library and load image to process:\n\u0060\u0060\u0060fsharp\nopen ImageProcessing\n\nlet myImage = MyImage.load (\u0022Full/Path/To/Images/Folder/image_name.jpg\u0022)\n\u0060\u0060\u0060\n\nCreate new function which sequentially applies blur filter and clockwise rotation to images and saves it on CPU:\n\n\u0060\u0060\u0060fsharp\nlet applyCustomFilterOnCPU (image: MyImage) (pathToSave : string) = \n    let blurredImage = image |\u003E CPU.applyFilter gaussianBlurKernel\n    let rotatedImage = blurredImage |\u003E CPU.rotate true\n    \n    MyImage.save rotatedImage pathToSave\n\u0060\u0060\u0060\n\nCreate the same function for GPU. But before it we need to do some steps for diagnosing graphical device.\n\nDefine the \u0060\u0060device\u0060\u0060 value by specifying the brand of your GPU or whatever the program finds (embedded graphics cards are also suitable). And make OpenCL context of it:\n\n\u0060\u0060\u0060fsharp\nlet device = Brahma.FSharp.ClDevice.GetFirstAppropriateDevice()\nlet clContext = Brahma.FSharp.ClContext(device)\n\u0060\u0060\u0060\n\nNext, define new values for filter and rotation functions. This action is necessary because of compiling [kernel function]() once:\n\u0060\u0060\u0060fsharp\nlet applyFilterGPU = GPU.applyFilter clContext 64\nlet rotateGPU = GPU.rotate clContext 64\n\u0060\u0060\u0060\nAnd the final function:\n\u0060\u0060\u0060fsharp\nlet applyCustomFilterOnGPU (image: MyImage) (pathToSave : string) = \n    let blurredImage = image |\u003E applyFilterGPU gaussianBlurKernel\n    let rotatedImage = blurredImage |\u003E rotateGPU true\n    \n    MyImage.save rotatedImage pathToSave\n\u0060\u0060\u0060\n\nThe result:\n\u0060\u0060\u0060fsharp\nopen ImageProcessing\n\nlet myImage = MyImage.load (\u0022Full/Path/To/Images/Folder/image_name.jpg\u0022)\n\nlet applyCustomFilterOnCPU (image: MyImage) (pathToSave : string) = \n    let blurredImage = image |\u003E CPU.applyFilter gaussianBlurKernel\n    let rotatedImage = blurredImage |\u003E CPU.rotate true\n    \n    MyImage.save rotatedImage pathToSave\n\nlet device = Brahma.FSharp.ClDevice.GetFirstAppropriateDevice()\nlet clContext = Brahma.FSharp.ClContext(device)\n\nlet applyCustomFilterOnGPU (image: MyImage) (pathToSave : string) = \n    let blurredImage = image |\u003E applyFilterGPU gaussianBlurKernel\n    let rotatedImage = blurredImage |\u003E rotateGPU true\n    \n    MyImage.save rotatedImage pathToSave\n \nlet pathToSave = \u0022Path/To/Directory/image_name.jpg\u0022\napplyCustomFilterOnCPU myImage pathToSave\napplyCustomFilterOnGPU myImage pathToSave\n\u0060\u0060\u0060\n\n## Features\n\nThe following features are implemented, even for CPU and GPU:\n\n* **Filters**\n  * Gaussian Blur\n  * Edges\n  * Sharpen\n  * Lighten\n  * Darken\n\n\n* **Transformations**\n  * Clockwise rotation\n  * Counterclockwise rotation\n  * Vertical flip (Y-axis)\n  * Horizontal flip (X-axis)\n\n\n* **Multithreaded processing tools**\n  * Saving agent\n  * Processing agent\n  * Full processing agent, i.e saving plus processing\n  * Events logger\n\n\n* **Directory with pictures processing tool**\n\nFor detailed descriptions of all features above visit [Api Reference]().\n\nThe final result for all types of transformations and filters:\n\n|Original|Sharpen|\n|:-------|:------|\n| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplash2.jpg)  | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashSharpen.jpg) |\n\n|Gauss|Edges|\n|:-------|:------|\n| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashGauss.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashEdges.jpg) |\n\n|Darken|Lighten|\n|:-------|:------|\n| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashDarken.jpg)  | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashLighten.jpg) |\n\n\n|Rotation R|Rotation L|\n|:-------|:------|\n| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashRotation.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashRotationF.jpg) |\n\n|Flip H|Flip V|\n|:-------|:------|\n| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashFlipF.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashFlip.jpg) |\n\n"}]
\ No newline at end of file
diff --git a/docsSrc/Tutorials/Getting_Started.md b/docsSrc/Tutorials/Getting_Started.md
index 4ae2391..79bee5b 100644
--- a/docsSrc/Tutorials/Getting_Started.md
+++ b/docsSrc/Tutorials/Getting_Started.md
@@ -7,16 +7,164 @@ index: 1
 
 # Getting Started
 
+## Prepearing
+
+### Requirements
+
+First of all, make sure the following requirements are installed on your system:
+
+- [dotnet SDK](https://www.microsoft.com/net/download/core) 3.0 or higher (recommended 6.0+),
+- [Mono](http://www.mono-project.com/) if you're on Linux or macOS or
+- [VSCode Dev Container](https://code.visualstudio.com/docs/remote/containers).
+
+To find more building and running options take a look at the [MiniScaffold](https://github.com/TheAngryByrd/MiniScaffold) template.
+
+### Package Adding
+
+Go to directory with your ``build.fsproj`` (or ``build.csproj``) file and install ImageProcessing using command line:
+
+    [lang=bash]
+    dotnet add package ImageProcessing --version 1.0.0
+
+For more information visit package main [GitHub page](https://github.com/PolinaSavelyeva/ImageProcessing/pkgs/nuget/ImageProcessing).
+
+## Simple Usage
+
+### Using CLI
+Before usage, go to specify directory:
+```sh
+$ cd /path/to/ImageProcessing/src/ImageProcessing
+```
+To process images from one directory and save them to another, you can use the following commands.
+
+- #### Оne transformation applied to each image in the directory
+```sh
+$ dotnet run -in /input/path -out /output/path -agent=full -unit=cpu gauss
+```
+- #### List of transformations that are sequentially applied
+```sh
+$ dotnet run -in /input/path -out /output/path  -agent=no -unit=anygpu gauss sharpen
+```
+More details about CLI processing you can find [here]().
+
+### Using Your Own Code
+
+Open library and load image to process:
 ```fsharp
-open GPUImageProcessing
-let foo = ()
-let myAge = 21
-let color = Say.FavoriteColor.Red
+open ImageProcessing
+
+let myImage = MyImage.load ("Full/Path/To/Images/Folder/image_name.jpg")
 ```
 
-## Here is the path to downloading
+Create new function which sequentially applies blur filter and clockwise rotation to images and saves it on CPU:
 
-    [lang=bash]
-    paket install GPUImageProcessing
+```fsharp
+let applyCustomFilterOnCPU (image: MyImage) (pathToSave : string) = 
+    let blurredImage = image |> CPU.applyFilter gaussianBlurKernel
+    let rotatedImage = blurredImage |> CPU.rotate true
+    
+    MyImage.save rotatedImage pathToSave
+```
+
+Create the same function for GPU. But before it we need to do some steps for diagnosing graphical device.
+
+Define the ``device`` value by specifying the brand of your GPU or whatever the program finds (embedded graphics cards are also suitable). And make OpenCL context of it:
+
+```fsharp
+let device = Brahma.FSharp.ClDevice.GetFirstAppropriateDevice()
+let clContext = Brahma.FSharp.ClContext(device)
+```
+
+Next, define new values for filter and rotation functions. This action is necessary because of compiling [kernel function]() once:
+```fsharp
+let applyFilterGPU = GPU.applyFilter clContext 64
+let rotateGPU = GPU.rotate clContext 64
+```
+And the final function:
+```fsharp
+let applyCustomFilterOnGPU (image: MyImage) (pathToSave : string) = 
+    let blurredImage = image |> applyFilterGPU gaussianBlurKernel
+    let rotatedImage = blurredImage |> rotateGPU true
+    
+    MyImage.save rotatedImage pathToSave
+```
+
+The result:
+```fsharp
+open ImageProcessing
+
+let myImage = MyImage.load ("Full/Path/To/Images/Folder/image_name.jpg")
+
+let applyCustomFilterOnCPU (image: MyImage) (pathToSave : string) = 
+    let blurredImage = image |> CPU.applyFilter gaussianBlurKernel
+    let rotatedImage = blurredImage |> CPU.rotate true
+    
+    MyImage.save rotatedImage pathToSave
+
+let device = Brahma.FSharp.ClDevice.GetFirstAppropriateDevice()
+let clContext = Brahma.FSharp.ClContext(device)
+
+let applyCustomFilterOnGPU (image: MyImage) (pathToSave : string) = 
+    let blurredImage = image |> applyFilterGPU gaussianBlurKernel
+    let rotatedImage = blurredImage |> rotateGPU true
+    
+    MyImage.save rotatedImage pathToSave
+ 
+let pathToSave = "Path/To/Directory/image_name.jpg"
+applyCustomFilterOnCPU myImage pathToSave
+applyCustomFilterOnGPU myImage pathToSave
+```
+
+## Features
+
+The following features are implemented, even for CPU and GPU:
+
+* **Filters**
+  * Gaussian Blur
+  * Edges
+  * Sharpen
+  * Lighten
+  * Darken
+
+
+* **Transformations**
+  * Clockwise rotation
+  * Counterclockwise rotation
+  * Vertical flip (Y-axis)
+  * Horizontal flip (X-axis)
+
+
+* **Multithreaded processing tools**
+  * Saving agent
+  * Processing agent
+  * Full processing agent, i.e saving plus processing
+  * Events logger
+
+
+* **Directory with pictures processing tool**
+
+For detailed descriptions of all features above visit [Api Reference]().
+
+The final result for all types of transformations and filters:
+
+|Original|Sharpen|
+|:-------|:------|
+| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplash2.jpg)  | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashSharpen.jpg) |
+
+|Gauss|Edges|
+|:-------|:------|
+| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashGauss.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashEdges.jpg) |
+
+|Darken|Lighten|
+|:-------|:------|
+| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashDarken.jpg)  | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashLighten.jpg) |
+
+
+|Rotation R|Rotation L|
+|:-------|:------|
+| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashRotation.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashRotationF.jpg) |
 
+|Flip H|Flip V|
+|:-------|:------|
+| ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashFlipF.jpg) | ![image](https://raw.githubusercontent.com/PolinaSavelyeva/ImageProcessing/main/resources/david-clode-78YxP3PP05A-unsplashFlip.jpg) |
 
diff --git a/docsSrc/index.md b/docsSrc/index.md
index a81e1b8..ca96a6e 100644
--- a/docsSrc/index.md
+++ b/docsSrc/index.md
@@ -1,4 +1,4 @@
-# ImageProcessing
+# Introduction to ImageProcessing
 
 ---
 
@@ -10,7 +10,15 @@ and GPU or agent-supported processing, all accessible within the included consol
 
 ## Why use ImageProcessing?
 
-I created it because I had to solve an issue with this other thing.
+It can helps you to process your images quickly using GPU or only command-line. 
+
+There is some of the features implemented in ImageProcessing.
+- Loading images from a local source and saving them.
+- Processing all images within a specified directory.
+- Filtering using one of five kernels, including "Gaussian blur" and "edges".
+- Other edits such as 90-degree rotation and flipping.
+- Combinations of existing transformations in four different scenarios.
+- Ability to utilize all of the features solely through the command line.
 
 ---
 
@@ -18,30 +26,30 @@ I created it because I had to solve an issue with this other thing.
   

     

       

-        
Tutorials

-        
Takes you by the hand through a series of steps to create your first thing. 

+        
How-To make your own code

+        
Create new processing function using "bricks" via ImageProcessing. 

       

       

-        Get started
+        Get started
       

     

   

   

     

       

-        
How-To Guides

-        
Guides you through the steps involved in addressing key problems and use-cases. 

+        
How-To use CLI

+        
Quickly process your images using command line. 

       

       

-        Learn Usecases
+        Learn Usecases
       

     

   

   

     

       

-        
Explanations

-        
Discusses key topics and concepts at a fairly high level and provide useful background information and explanation..

+        
Library structure

+        
Helps you better understanding library's functions, modules and structures dependencies. 

       

       

         Dive Deeper