jxkn commited on
Commit
bcab24d
·
1 Parent(s): efe8fc6

docs: changed define-inputs-and-outputs.mdx

Browse files
docs/creating-pipelines/define-inputs-and-outputs.mdx CHANGED
@@ -2,89 +2,91 @@
2
  sidebar_position: 2
3
  ---
4
 
5
- # Define Inputs & Outputs
6
 
7
- To make your pipeline interactive and user-friendly, you need to define **inputs** (what the user can control) and **outputs** (what the pipeline returns).
8
 
9
- Inputs and outputs are made available by **extracting them from specific nodes**. This makes them visible in the **Playground** (for user input) and **Results tab** (for viewing outputs).
10
 
11
  ---
12
 
13
- ## Extracting Inputs & Outputs
14
 
15
- To expose an input or output:
16
 
17
- 1. Hover over the desired node.
18
- 2. Click the small **circle port** of the input or output you want to extract.
19
- 3. Press the **"Take out"** button.
20
 
21
- Once extracted, the item will appear in the Playground interface (for inputs) or Results tab (for outputs).
 
 
22
 
23
  ---
24
 
25
- ## 1. Defining Inputs
26
 
27
- ### Option A: Through the Playground
28
 
29
- After extracting inputs, they automatically appear in the **Playground** — a simple interface for providing data to your pipeline.
30
 
31
- Users can:
32
 
33
- - Enter values directly into the input fields
34
- - Run the pipeline using those values
35
- - View results instantly in the interface
36
 
37
- #### Setting Default Values
38
 
39
- You can define **default values** that will be shown in the Playground:
40
 
41
- 1. Click on the **name** of an input field.
42
- 2. This opens the **input editor**.
43
- 3. Enter the default value — it will be pre-filled for users but can still be changed.
44
 
45
- #### Organizing Inputs
46
 
47
- To rearrange inputs for better clarity:
48
 
49
- - Click and hold the input field
50
- - Drag it using the **hand icon**
51
 
52
  :::tip
53
- Place inputs in a logical and visually clear layout to improve usability, especially in larger pipelines.
54
  :::
55
 
56
- You can extract inputs from **multiple nodes**, regardless of their order in the pipeline.
57
 
58
  ---
59
 
60
- ### Option B: Through the Node Editor (Workspace)
61
 
62
- You can also configure node inputs directly inside the node editor:
63
 
64
- 1. Hover over a node and click the **edit icon**.
65
- 2. The editor displays all configurable inputs for that node.
66
 
67
- Here you can:
68
 
69
- - Set **default values** — used when the Playground input is empty
70
- - Enable or disable **auto-run** (toggle in the top-left corner)
71
 
72
- > If auto-run is enabled, the node executes when the pipeline starts.
73
- > If disabled, it runs only after receiving data from another node.
74
 
75
- To test pipeline execution from the workspace, press the **Play** button in the top-left corner. The entire pipeline will run, and results will be shown inline.
76
 
77
  ---
78
 
79
- ## 2. Defining Outputs
80
 
81
- To expose the final result of the pipeline:
82
 
83
- 1. Click on the **output port** of the node.
84
- 2. Press **"Take out"** — the output will now be visible in:
85
- - The **Results** tab after execution
86
- - The **Playground**, where results appear interactively
87
 
88
- You can extract outputs from **any node**, regardless of its position or execution order. This makes it easy to monitor intermediate values or final results.
89
 
90
- In the next section, we’ll look at how to **connect nodes** to pass data between them.
 
2
  sidebar_position: 2
3
  ---
4
 
5
+ # Определение входов и выходов
6
 
7
+ Чтобы сделать ваш пайплайн интерактивным и удобным для пользователя, необходимо определить **входы** (то, что контролирует пользователь) и **выходы** (то, что возвращает пайплайн).
8
 
9
+ Входы и выходы становятся доступными через **извлечение их из определённых нод**. После этого они отображаются в **Playground** (для пользовательского ввода) и на вкладке **Results** (для просмотра результатов).
10
 
11
  ---
12
 
13
+ ## Извлечение входов и выходов
14
 
15
+ Чтобы извлечь вход или выход:
16
 
17
+ 1. Наведите курсор на нужную ноду.
18
+ 2. Нажмите на маленький **круглый порт** у входа или выхода, который хотите извлечь.
19
+ 3. Нажмите кнопку **"Take out"**.
20
 
21
+ ![Extract Inputs and Outputs](../img/extract_inputs_outputs.webp)
22
+
23
+ После извлечения элемент появится в интерфейсе Playground (для входов) или на вкладке Results (для выходов).
24
 
25
  ---
26
 
27
+ ## 1. Определение входов
28
 
29
+ ### Вариант A: Через Playground
30
 
31
+ После извлечения входов они автоматически появляются в **Playground** — простом интерфейсе для передачи данных в пайплайн.
32
 
33
+ Пользователь может:
34
 
35
+ - Вводить значения прямо в поля ввода
36
+ - Запускать пайплайн с этими значениями
37
+ - Сразу видеть результаты в интерфейсе
38
 
39
+ #### Задание значений по умолчанию
40
 
41
+ Вы можете задать **значения по умолчанию**, которые будут отображаться в Playground:
42
 
43
+ 1. Нажмите на **название** поля ввода.
44
+ 2. Откроется **редактор входа**.
45
+ 3. Укажите значение по умолчанию — оно будет предварительно заполнено, но пользователь сможет его изменить.
46
 
47
+ #### Организация входов
48
 
49
+ Чтобы упорядочить входы для лучшей читаемости:
50
 
51
+ - Зажмите поле ввода
52
+ - Перетащите его с помощью **иконки руки**
53
 
54
  :::tip
55
+ Размещайте входы логично и наглядно, особенно в больших пайплайнах — это сильно повышает удобство работы.
56
  :::
57
 
58
+ Можно извлекать входы из **нескольких нод**, независимо от их расположения в пайплайне.
59
 
60
  ---
61
 
62
+ ### Вариант B: Через редактор ноды (Workspace)
63
 
64
+ Вы также можете настраивать входы прямо в редактор�� ноды:
65
 
66
+ 1. Наведите курсор на ноду и нажмите **иконку редактирования**.
67
+ 2. В редакторе отобразятся все настраиваемые входы этой ноды.
68
 
69
+ Здесь можно:
70
 
71
+ - Устанавливать **значения по умолчанию** — они используются, если в Playground поле пустое
72
+ - Включать или отключать **автозапуск** (переключатель в левом верхнем углу)
73
 
74
+ > Если автозапуск включён, нода выполняется сразу при старте пайплайна.
75
+ > Если выключен — только после получения данных от другой ноды.
76
 
77
+ Чтобы протестировать запуск пайплайна прямо из Workspace, нажмите кнопку **Play** в левом верхнем углу. Весь пайплайн выполнится, а результаты отобразятся прямо внутри редактора.
78
 
79
  ---
80
 
81
+ ## 2. Определение выходов
82
 
83
+ Чтобы извлечь итоговый результат пайплайна:
84
 
85
+ 1. Нажмите на **выходной порт** ноды.
86
+ 2. Нажмите кнопку **"Take out"** — теперь выход будет доступен:
87
+ - На вкладке **Results** после выполнения пайплайна
88
+ - В **Playground**, где результаты будут отображаться интерактивно
89
 
90
+ Вы можете извлекать выходы из **любой ноды**, независимо от её позиции или порядка выполнения. Это позволяет удобно отслеживать как промежуточные данные, так и итоговые результаты.
91
 
92
+ В следующем разделе мы рассмотрим, как **соединять ноды**, чтобы передавать данные между ними.
i18n/ru/docusaurus-plugin-content-docs/current/creating-pipelines/add-nodes-to-canvas.mdx CHANGED
@@ -2,59 +2,70 @@
2
  sidebar_position: 1
3
  ---
4
 
5
- # Добавление нод на холст
6
 
7
  ## Меню нод
8
 
9
  Нажмите кнопку **Добавить ноду**:
10
 
11
- Откроется библиотека с доступными нодами:
 
 
12
 
13
  ## Категории нод
14
 
15
- Библиотека организована по категориям в зависимости от функционала ноды. Ниже представлены доступные разделы:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
- | Категория | Описание |
18
- |---------------------|--------------------------------------------------------|
19
- | Генерация изображений | Создание и редактирование изображений |
20
- | Обработка видео | Работа с видео: разделение на кадры и объединение |
21
- | Языковые агенты | Взаимодействие с языковыми моделями |
22
- | Сервисные ноды | Утилиты для работы с изображениями, текстом и JSON |
23
- | Волшебный портрет | Редактирование портретов и лиц |
24
- | Работа с изображениями| Улучшение и обработка изображений |
25
- | Анализ изображений | Анализ изображений с помощью ИИ |
26
- | Обработка текста | Обработка и перевод текста |
27
- | Генерация видео | Создание видео из текста и изображений |
28
- | Компьютерное зрение | Ноды для задач компьютерного зрения (скоро) |
29
 
30
- Например, добавим ноду `ChatGPT` на холст. Для этого просто кликните по нужной ноде:
31
 
32
- ## Перемещение нод на холсте
33
 
34
- После добавления ноды её можно перемещать по рабочему пространству.
35
 
36
- Чтобы изменить позицию ноды, используйте **перетаскивание** — нажмите и удерживайте иконку перемещения:
37
 
38
- Перетащите ноду в нужное место:
 
 
39
 
40
  :::tip
41
- При работе с несколькими нодами размещайте их аккуратно, чтобы пайплайна оставалась понятной и удобной.
42
  :::
43
 
44
  ## Удаление ноды
45
 
46
- Вы можете удалить ноду прямо из редактора:
47
 
48
- 1. Наведите курсор на ноду.
49
- 2. Откройте редактор, кликнув по **иконке редактирования**.
50
- 3. В правом верхнем углу нажмите кнопку **Удалить**.
51
 
 
52
 
53
  ## Закрытие меню нод
54
 
55
- Чтобы закрыть меню нод, вы можете:
56
 
57
  - Нажать `Esc` на клавиатуре, или
58
- - Кликнуть по кнопке закрытия.
 
 
59
 
60
- ---
 
2
  sidebar_position: 1
3
  ---
4
 
5
+ # Добавление нод на канвас
6
 
7
  ## Меню нод
8
 
9
  Нажмите кнопку **Добавить ноду**:
10
 
11
+ ![Add Node Button](../img/add_node_menu_button.jpg)
12
+
13
+ Откроется библиотека нод со списком всех доступных элементов.
14
 
15
  ## Категории нод
16
 
17
+ Библиотека нод организована по категориям в зависимости от их функционала. Вот обзор доступных разделов:
18
+
19
+ | Категория | Описание |
20
+ |---------------------|-------------------------------------------------------|
21
+ | Генерация изображений | Создание и редактирование изображений |
22
+ | Обработка видео | Работа с видео: разбиение на кадры и объединение |
23
+ | Языковые агенты | Взаимодействие с языковыми моделями |
24
+ | Служебные ноды | Вспомогательные ноды для работы с изображениями, текстом и JSON |
25
+ | Magic Portrait | Редактирование портретов и лиц |
26
+ | Работа с изображениями | Улучшение и обработка изображений |
27
+ | Анализ изображений | Анализ изображений с помощью ИИ |
28
+ | Обработка текста | Работа с текстом и перевод |
29
+ | Генерация видео | Создание видео из текста и изображений |
30
+ | Компьютерное зрение | Ноды для задач компьютерного зрения (в разработке) |
31
+
32
+ Например, давайте добавим на канвас ноду `ChatGPT`. Для этого просто нажмите на нужную ноду:
33
 
34
+ ![Adding node](../img/adding_node.webp)
 
 
 
 
 
 
 
 
 
 
 
35
 
36
+ ## Перемещение нод на канвасе
37
 
38
+ После добавления ноду можно свободно перемещать в рабочей области.
39
 
40
+ Чтобы изменить расположение ноды, используйте **перетаскивание** — зажмите иконку перемещения:
41
 
42
+ ![Drag And Drop Icon](../img/drag_and_drop.jpg)
43
 
44
+ Затем перен��сите ноду в нужное место в рабочей области:
45
+
46
+ ![Drag And Drop Video](../img/drag_and_drop_video.webp)
47
 
48
  :::tip
49
+ Если вы работаете с несколькими нодами, размещайте их аккуратно, чтобы пайплайн оставался чистым и удобным для навигации.
50
  :::
51
 
52
  ## Удаление ноды
53
 
54
+ Удалить ноду можно прямо в редакторе:
55
 
56
+ 1. Наведите курсор на ноду.
57
+ 2. Откройте редактор ноды, нажав на **иконку редактирования**.
58
+ 3. В правом верхнем углу нажмите кнопку **Удалить**.
59
 
60
+ ![Node Deletion](../img/node_deletion.webp)
61
 
62
  ## Закрытие меню нод
63
 
64
+ Чтобы закрыть меню нод, можно:
65
 
66
  - Нажать `Esc` на клавиатуре, или
67
+ - Кликнуть на кнопку закрытия.
68
+
69
+ ![Exit Button](../img/exit_button.webp)
70
 
71
+ ---
i18n/ru/docusaurus-plugin-content-docs/current/creating-pipelines/connect-nodes.mdx CHANGED
@@ -4,30 +4,32 @@ sidebar_position: 3
4
 
5
  # Соединение нод
6
 
7
- Давайте разберёмся, как добавлять несколько нод на холст и соединять их в полноценную пайплайну.
8
 
9
  ## Добавление нескольких нод
10
 
11
- Начните с добавления нескольких нод через меню.
12
- Например, добавим ноду `Generate on Flux` к уже существующей `ChatGPT`:
13
 
14
- Поскольку выход `ChatGPT` — это текст, а `Generate on Flux` принимает текст на вход, эти ноды можно соединить напрямую:
 
 
15
 
16
  :::tip
17
- Вы можете строить большие пайплайны из множества нод. Однако помните, что скорость генерации может снижаться при увеличении количества нод.
18
  :::
19
 
20
  ---
21
 
22
- ## Как соединить ноды
23
 
24
  Чтобы соединить две ноды:
25
 
26
- 1. Наведите курсор на **выходной порт** первой ноды.
27
- 2. Нажмите и удерживайте мышь, протяните линию соединения к **входному порту** второй ноды.
28
- 3. Отпустите мышь.
29
 
30
- Если типы данных совместимы — соединение произойдёт успешно.
31
 
32
  ---
33
 
@@ -35,45 +37,47 @@ sidebar_position: 3
35
 
36
  Каждая нода имеет определённые типы входов и выходов, например:
37
 
38
- - **Boolean** — логическое значение (истина/ложь)
39
- - **Integer** — целое число
40
- - **Float** — число с плавающей запятой
41
- - **String** или **String[]** — строка или массив строк
42
- - **Image** или **Image[]** — изображение или массив изображений
43
- - **Archive** — архив (zip и т.п.)
44
- - **Audio** — аудио
45
- - **Video** — видео
46
- - **JSON** — данные в формате JSON
47
 
48
- Вы можете соединять порты **только с совместимыми типами данных**.
49
 
50
  :::danger
51
- Попытка соединить несовместимые порты приведёт к отсутствию соединения.
52
  :::
53
 
54
  ---
55
 
56
  ## Удаление соединения
57
 
58
- Чтобы удалить связь между нодами:
 
 
 
59
 
60
- 1. Наведите курсор на линию соединения.
61
- 2. Когда линия подсветится и курсор сменится на **значок X**, кликните — соединение удалится.
62
 
63
- :::tip
64
- Подсветка линии указывает на то, что соединение можно удалить.
65
  :::
66
 
67
- Так вы наглядно видите, как данные передаются от одной ноды к другой.
68
 
69
  ---
70
 
71
  ## Решение проблем с соединением
72
 
73
- Если возникают сложности с соединением нод:
74
 
75
- - ✅ **Проверьте типы данных** на портах — наведите курсор, чтобы увидеть поддерживаемые форматы.
76
- - 🔁 **Обновите холст** или повторно добавьте ноду, если возникли ошибки.
77
- - ⚠️ **Проверьте индикатор статуса** в правом верхнем углу экрана:
78
- - 🟢 **Saved** — пайплайна валидна
79
- - 🔴 **Error** — в пайплайне есть ошибка
 
4
 
5
  # Соединение нод
6
 
7
+ Давайте разберёмся, как добавлять несколько нод на канвас и соединять их в полноценный пайплайн.
8
 
9
  ## Добавление нескольких нод
10
 
11
+ Начните с добавления нескольких нод из меню нод.
12
+ Например, добавим ноду `Generate on Flux` к уже существующей ноде `ChatGPT`.
13
 
14
+ Так как выходные данные ноды `ChatGPT` — это текст, а нода `Generate on Flux` принимает текст на вход, их можно соединить напрямую:
15
+
16
+ ![Node Connection](../img/nodes_connection.webp)
17
 
18
  :::tip
19
+ Вы можете строить большие пайплайны, используя множество нод. Но имейте в виду: чем больше пайплайн, тем медленнее может идти генерация.
20
  :::
21
 
22
  ---
23
 
24
+ ## Как соединять ноды
25
 
26
  Чтобы соединить две ноды:
27
 
28
+ 1. Наведите курсор на **выходной порт** первой ноды.
29
+ 2. Кликните и перетащите линию соединения к **входному порту** второй ноды.
30
+ 3. Отпустите кнопку мыши.
31
 
32
+ Если типы данных совместимы, соединение будет установлено успешно.
33
 
34
  ---
35
 
 
37
 
38
  Каждая нода имеет определённые типы входов и выходов, например:
39
 
40
+ - **Boolean**
41
+ - **Integer**
42
+ - **Float**
43
+ - **String** или **String[]** (массив строк)
44
+ - **Image** или **Image[]** (массив изображений)
45
+ - **Archive**
46
+ - **Audio**
47
+ - **Video**
48
+ - **JSON**
49
 
50
+ Вы можете соединять только те выходы и входы, у которых совпадают или конвертируются типы данных.
51
 
52
  :::danger
53
+ Попытка соединить несовместимые порты не приведёт к созданию соединения.
54
  :::
55
 
56
  ---
57
 
58
  ## Удаление соединения
59
 
60
+ Чтобы удалить соединение между двумя нодами:
61
+
62
+ 1. Наведите курсор на линию соединения.
63
+ 2. Когда линия подсветится, а курсор изменится на иконку **"X"**, кликните для удаления.
64
 
65
+ ![Connection Delete](../img/connection_delete.webp)
 
66
 
67
+ :::tip Совет
68
+ Подсветка линии указывает на то, что её можно удалить.
69
  :::
70
 
71
+ Так можно наглядно отслеживать, как данные проходят через цепочку нод шаг за шагом.
72
 
73
  ---
74
 
75
  ## Решение проблем с соединением
76
 
77
+ Если у вас возникают трудности при соединении нод:
78
 
79
+ - ✅ **Проверьте типы данных** портов — наведите курсор, чтобы увидеть поддерживаемые входы/выходы.
80
+ - 🔁 **Попробуйте обновить** канвас или заново добавить проблемную ноду.
81
+ - ⚠️ **Проверьте индикатор статуса** в правом верхнем углу экрана:
82
+ - 🟢 **Сохранено** — пайплайн корректен
83
+ - 🔴 **Ошибка** — в пайплайне есть проблема