diff --git a/Writerside/topics/Allor-Doc.md b/Writerside/topics/Allor-Doc.md index cb1a835..9f0ec29 100644 --- a/Writerside/topics/Allor-Doc.md +++ b/Writerside/topics/Allor-Doc.md @@ -1,6 +1,6 @@ # Introducing -![logo](documentation.png){width="706"} +![logo](documentation.png){ width="706" } > Welcome to `Allor Documentation`. This is your go-to resource for detailed information and guides on how to > use Allor effectively. Whether you’re just starting out or looking for advanced tips, we’re here to help. diff --git a/Writerside/topics/Alpha-Chanel.md b/Writerside/topics/Alpha-Chanel.md index 138dac5..d7f9862 100644 --- a/Writerside/topics/Alpha-Chanel.md +++ b/Writerside/topics/Alpha-Chanel.md @@ -1,3 +1,3 @@ # Alpha Chanel -![alpha_chanel](alpha_chanel.png){ border-effect="rounded" } +![alpha_chanel](alpha_chanel.png){ border-effect="rounded" width="706" } diff --git a/Writerside/topics/Clamp.md b/Writerside/topics/Clamp.md index a56d73e..7d645f6 100644 --- a/Writerside/topics/Clamp.md +++ b/Writerside/topics/Clamp.md @@ -1,3 +1,3 @@ # Clamp -![clamp](clamp.png) +![clamp](clamp.png){ border-effect="rounded" width="706" } diff --git a/Writerside/topics/Configuration.md b/Writerside/topics/Configuration.md index 97aeb80..599c13f 100644 --- a/Writerside/topics/Configuration.md +++ b/Writerside/topics/Configuration.md @@ -5,7 +5,7 @@ based on the template found in `template/template.json`. In the event of an **update**, the configuration file **automatically adapts** to all changes. It **preserves old parameters** while removing outdated ones and applying new ones. This ensures that your configuration stays -**up-to-date** with the latest features and improvements. +**up to date** with the latest features and improvements. ## Modules @@ -93,7 +93,7 @@ available in Allor. By default, all overrides are **disabled** (set to `false`). ImageInvert - ImageTransfromRotate + ImageTransformRotate ImageTransformTranspose diff --git a/Writerside/topics/Image-Batch.md b/Writerside/topics/Image-Batch.md index 73330d4..062d6c5 100644 --- a/Writerside/topics/Image-Batch.md +++ b/Writerside/topics/Image-Batch.md @@ -1,4 +1,4 @@ # Image Batch -![image_batch](image_batch.png) +![image_batch](image_batch.png){ border-effect="rounded" width="706" } diff --git a/Writerside/topics/Image-Composite.md b/Writerside/topics/Image-Composite.md index 27ed645..cbe5c7b 100644 --- a/Writerside/topics/Image-Composite.md +++ b/Writerside/topics/Image-Composite.md @@ -1,3 +1,3 @@ # Image Composite -![image_composite](image_composite.png) +![image_composite](image_composite.png) { border-effect="rounded" width="706" } diff --git a/Writerside/topics/Image-Container.md b/Writerside/topics/Image-Container.md index c726dd2..2fac80b 100644 --- a/Writerside/topics/Image-Container.md +++ b/Writerside/topics/Image-Container.md @@ -1,3 +1,3 @@ # Image Container -![image_container](image_container.png) +![image_container](image_container.png) { border-effect="rounded" width="706" } diff --git a/Writerside/topics/Image-Draw.md b/Writerside/topics/Image-Draw.md index 93830b3..af346ac 100644 --- a/Writerside/topics/Image-Draw.md +++ b/Writerside/topics/Image-Draw.md @@ -1,3 +1,3 @@ # Image Draw -![image_draw](image_draw.png) +![image_draw](image_draw.png){ border-effect="rounded" width="706" } diff --git a/Writerside/topics/Image-Effects.md b/Writerside/topics/Image-Effects.md index fb650bc..f678f97 100644 --- a/Writerside/topics/Image-Effects.md +++ b/Writerside/topics/Image-Effects.md @@ -1,3 +1,3 @@ # Image Effects -![image_effects](image_effects.png) +![image_effects](image_effects.png){ border-effect="rounded" width="706" } diff --git a/Writerside/topics/Image-Filter.md b/Writerside/topics/Image-Filter.md index 8077a80..0e69d8b 100644 --- a/Writerside/topics/Image-Filter.md +++ b/Writerside/topics/Image-Filter.md @@ -1,3 +1,3 @@ # Image Filter -![image_filter](image_filter.png) +![image_filter](image_filter.png){ border-effect="rounded" width="706" } diff --git a/Writerside/topics/Image-Segmentation.md b/Writerside/topics/Image-Segmentation.md index 4b3b739..80f1a61 100644 --- a/Writerside/topics/Image-Segmentation.md +++ b/Writerside/topics/Image-Segmentation.md @@ -1,3 +1,3 @@ # Image Segmentation -![image_segmentation](image_segmentation.png) +![image_segmentation](image_segmentation.png){ border-effect="rounded" width="706" } diff --git a/Writerside/topics/Image-Text.md b/Writerside/topics/Image-Text.md index 984d969..c70829a 100644 --- a/Writerside/topics/Image-Text.md +++ b/Writerside/topics/Image-Text.md @@ -1,3 +1,3 @@ # Image Text -![image_text](image_text.png) +![image_text](image_text.png){ border-effect="rounded" width="706" } diff --git a/Writerside/topics/Image-Transform.md b/Writerside/topics/Image-Transform.md index 24f31c5..1bf492b 100644 --- a/Writerside/topics/Image-Transform.md +++ b/Writerside/topics/Image-Transform.md @@ -1,3 +1,3 @@ # Image Transform -![image_transform](image_transform.png) +![image_transform](image_transform.png){ border-effect="rounded" width="706" } diff --git a/Writerside/topics/Installation.md b/Writerside/topics/Installation.md index 053466f..30f3817 100644 --- a/Writerside/topics/Installation.md +++ b/Writerside/topics/Installation.md @@ -1,7 +1,7 @@ # Installation -**Allor** can be installed not with such complexity as it seems at first glance. Rest assured that every possible -measure has been taken to streamline this process. +**Allor** can be installed not with such a complexity as it seems at first glance. +Rest assured that every possible measure has been taken to streamline this process. The installation script implemented within Allor ensures a smooth installation experience for all users, regardless of their technical proficiency. @@ -18,8 +18,7 @@ their technical proficiency. ## Installing with manager -If you have [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager) installed you can just install Allor by -manager. +If you have [ComfyUI-Manager](https://github.com/ltdrdata/ComfyUI-Manager) installed, you can install Allor by manager. ## Installing with direct download @@ -72,8 +71,8 @@ manager. -1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes` directory. You can do this by opening Terminal and using - the `cd` command. +1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes` directory. + You can do this by opening the Terminal and using the `cd` command. 2. **Clone the Repository**: Clone the repository by entering the following command: @@ -137,7 +136,7 @@ manager. 2. **Installs dependencies**: If a `requirements.txt` file exists in the current directory, the script installs the dependencies listed in it. -3. **Initializes a Git repository**: If Git is installed and the current directory is not already a Git repository, the +3. **Initializes a Git repository**: If Git is installed and the current directory is not yet a Git repository, the script initializes a new Git repository and syncs it with a remote repository. 4. **Uses GitPython**: If Git is not installed, the script uses GitPython, a Python library, to perform Git operations. diff --git a/Writerside/topics/Modules.md b/Writerside/topics/Modules.md index 5a26ba6..a8ee114 100644 --- a/Writerside/topics/Modules.md +++ b/Writerside/topics/Modules.md @@ -1,3 +1,99 @@ # Modules +In Allor, **modules** are integral components that are loaded into the **ComfyUI**, containing **nodes** that users +interact with. +This page provides detailed information about each module, helping you understand their **functionality**. + +In Allor, **modules** have the flexibility to utilize various **implementations** as a backend for nodes. +This versatility allows for a diverse range of **functionalities** and **interactions** within the plugin. + +Here is a backend list: + +* **PyTorch** — Image processing with Tensor without transformation. +* **NumPy** — PyTorch and NumPy arrays share their underlying memory locations, allowing for efficient transformations without any performance loss. +* **OpenCV** — An open-source library dedicated to real-time image processing. It offers even higher operation speeds than pure tensor processing. +* **Pillow** — A widely used Python library for image manipulation. Slow speed of work, if possible, we will switch from it to OpenCV. +* **Rembg** — A specialized library for removing image backgrounds. Despite its slower operation speed (up to 30 seconds), it provides effective background removal capabilities. + +### Alpha Chanel + +Module for working with **transparency** chanel in images. Allows you to create, add, restore or remove alpha chanel. + +**Backend**: PyTorch. + +### Image Container + +Module that allows you to create an **empty container** based on the images +for use as **size value** and **mathematical operations** with it. + +**Backend**: PyTorch. + +### Image Composite + +Module that allows you to **place images** of different sizes on top of **each other** while maintaining transparency. + +**Backend**: PyTorch. + +### Image Segmentation + +Module for **removing background** from images. +For the better result, it is recommended to add prompt that generates plain background. + +**Backend**: Rembg. + +### Image Text + +Module that allows you to **create text as image**. +In the future will be moved to Image Draw module. + +**Backend**: Pillow. + +### Image Draw + +Module for **draw figures** as images. +This module may be reworked in the future. + +**Backend**: Pillow. + +### Image Effects + +Module for working with **visual effects** and **optical distortions**. + +**Backend**: OpenCV, PyTorch. + +### Image Filter + +A module for changing the image by **applying mathematical operations**. +Unlike effects, it does not focus on artwork changes. + +**Backend**: Pillow. + +### Image Noise + +Module for working with noise on images. In early stage of development. + +**Backend**: NumPy. + +### Image Transform + +Module for **changing the representation** of images. +Allows you to resize, reflect, expand, rotate and crop images. + +**Backend**: PyTorch, Pillow. + +### Image Batch + +Module for comfortable work with **batch image processing**. +Allows adding images to batch, splitting, removing or getting the desired image from the array. + +**Backend**: PyTorch. + +### Clamp + +The module that provides a **strongly typed solution** to improve the **readability of nodes**. + +The nodes within this module uniquely have their module name positioned at the end of their name, +rather than at the beginning. + +**Backend**: PyTorch. diff --git a/Writerside/topics/Updating.md b/Writerside/topics/Updating.md index dcee7a5..ebd9113 100644 --- a/Writerside/topics/Updating.md +++ b/Writerside/topics/Updating.md @@ -22,7 +22,7 @@ configuration page. 1. **Open Terminal**: Navigate to the `ComfyUI/custom_nodes/ComfyUI-Allor` directory. You can do this by opening - Terminal and using the `cd` command. + the Terminal and using the `cd` command. 2. **Update the Repository**: Update the repository by entering the following command: