From e959130fa0ce72755a26fab48c8b06dbfe6cd179 Mon Sep 17 00:00:00 2001 From: Nourepide Date: Sun, 26 Nov 2023 08:21:44 +0300 Subject: [PATCH] Add Node Naming page. --- Writerside/allor-doc.tree | 1 + Writerside/images/icons/text_fields.svg | 38 +++++++++++++++++++++++++ Writerside/topics/Allor-Doc.md | 6 ++++ Writerside/topics/Node-Naming.md | 29 +++++++++++++++++++ 4 files changed, 74 insertions(+) create mode 100644 Writerside/images/icons/text_fields.svg create mode 100644 Writerside/topics/Node-Naming.md diff --git a/Writerside/allor-doc.tree b/Writerside/allor-doc.tree index 072047e..3ab6cd5 100644 --- a/Writerside/allor-doc.tree +++ b/Writerside/allor-doc.tree @@ -10,6 +10,7 @@ + diff --git a/Writerside/images/icons/text_fields.svg b/Writerside/images/icons/text_fields.svg new file mode 100644 index 0000000..d194ba6 --- /dev/null +++ b/Writerside/images/icons/text_fields.svg @@ -0,0 +1,38 @@ + + + + + + diff --git a/Writerside/topics/Allor-Doc.md b/Writerside/topics/Allor-Doc.md index cda83ef..35b5599 100644 --- a/Writerside/topics/Allor-Doc.md +++ b/Writerside/topics/Allor-Doc.md @@ -39,6 +39,12 @@

Tailor Allor to your needs for a truly personalized experience.

+ + configuration + +

Unravel the mystery behind the naming of nodes in Allor.

+ + cloud

Run in cloud

diff --git a/Writerside/topics/Node-Naming.md b/Writerside/topics/Node-Naming.md new file mode 100644 index 0000000..d484fa3 --- /dev/null +++ b/Writerside/topics/Node-Naming.md @@ -0,0 +1,29 @@ +# Node Naming + +At first glance, the node names in Allor may seem overly complex and long. However, don't rush to conclusions. The long +node names are not a coincidence, but a **thoughtful approach**. + +All node names in Allor are created according to a **unified rule**. This makes them more understandable and +informative, allowing users to **quickly understand** what each node does, just by looking at its name. + +The use of **descriptive names** is a good practice in programming, and it is widely used in many languages and +development environments. + +### Example: + + + ImageTransformResizeRelative + +
  • Image — This is the data type that the node belongs to. Image, Latent, Mask and the fourth dimension of image AlphaChannel are currently available.
    • +
  • Transform — This is the name of the module. Nodes in this module usually perform transformation or conversion functions.
    • +
  • Resize — This is the functionality of the node. The Resize node is typically used to change the size of the image data.
    • +
  • Relative — This is a postfix that further describes the functionality of the node. It refers to the precision of the node’s operation, in contrast to the Absolute postfix. There is also an Advanced postfix, which implies more extensive functionality.
    • +     +

    Simply by observing the node, you can discern its purpose: to image data transform, specifically adjusting tensor size with relative precision.

    +     + +## Exceptions + +In some cases, the part with the node's name can be omitted if the module name already sufficiently reflects its functionality. In such cases, the node's name in the documentation is indicated as **Default**. + +This helps to simplify node names when additional details do not add significant information.