Skip to content

Commit

Permalink
Write Modules page.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nourepide committed Nov 25, 2023
1 parent 532c859 commit 38858e8
Show file tree
Hide file tree
Showing 16 changed files with 117 additions and 22 deletions.
2 changes: 1 addition & 1 deletion Writerside/topics/Allor-Doc.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/Alpha-Chanel.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Alpha Chanel

![alpha_chanel](alpha_chanel.png){ border-effect="rounded" }
![alpha_chanel](alpha_chanel.png){ border-effect="rounded" width="706" }
2 changes: 1 addition & 1 deletion Writerside/topics/Clamp.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Clamp

![clamp](clamp.png)
![clamp](clamp.png){ border-effect="rounded" width="706" }
4 changes: 2 additions & 2 deletions Writerside/topics/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -93,7 +93,7 @@ available in Allor. By default, all overrides are **disabled** (set to `false`).
</tr>
<tr>
<td rowspan="2">ImageInvert</td>
<td>ImageTransfromRotate</td>
<td>ImageTransformRotate</td>
</tr>
<tr>
<td>ImageTransformTranspose</td>
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/Image-Batch.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Image Batch

![image_batch](image_batch.png)
![image_batch](image_batch.png){ border-effect="rounded" width="706" }

2 changes: 1 addition & 1 deletion Writerside/topics/Image-Composite.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Image Composite

![image_composite](image_composite.png)
![image_composite](image_composite.png) { border-effect="rounded" width="706" }
2 changes: 1 addition & 1 deletion Writerside/topics/Image-Container.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Image Container

![image_container](image_container.png)
![image_container](image_container.png) { border-effect="rounded" width="706" }
2 changes: 1 addition & 1 deletion Writerside/topics/Image-Draw.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Image Draw

![image_draw](image_draw.png)
![image_draw](image_draw.png){ border-effect="rounded" width="706" }
2 changes: 1 addition & 1 deletion Writerside/topics/Image-Effects.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Image Effects

![image_effects](image_effects.png)
![image_effects](image_effects.png){ border-effect="rounded" width="706" }
2 changes: 1 addition & 1 deletion Writerside/topics/Image-Filter.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Image Filter

![image_filter](image_filter.png)
![image_filter](image_filter.png){ border-effect="rounded" width="706" }
2 changes: 1 addition & 1 deletion Writerside/topics/Image-Segmentation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Image Segmentation

![image_segmentation](image_segmentation.png)
![image_segmentation](image_segmentation.png){ border-effect="rounded" width="706" }
2 changes: 1 addition & 1 deletion Writerside/topics/Image-Text.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Image Text

![image_text](image_text.png)
![image_text](image_text.png){ border-effect="rounded" width="706" }
2 changes: 1 addition & 1 deletion Writerside/topics/Image-Transform.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Image Transform

![image_transform](image_transform.png)
![image_transform](image_transform.png){ border-effect="rounded" width="706" }
13 changes: 6 additions & 7 deletions Writerside/topics/Installation.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -72,8 +71,8 @@ manager.

<procedure>

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:

Expand Down Expand Up @@ -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.
Expand Down
96 changes: 96 additions & 0 deletions Writerside/topics/Modules.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion Writerside/topics/Updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ configuration</a> page.
<procedure>

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:

Expand Down

0 comments on commit 38858e8

Please sign in to comment.