Einleitung
Dieses Repository enthält die Implementierung des Data Collection Prozesses für das Training der Large Action Models (LAMs) im Paper Large Action Models: From Inception to Implementation. Der Data Collection Prozess ist darauf ausgelegt, die Aufgabenverarbeitung zu optimieren und sicherzustellen, dass alle notwendigen Schritte von der Initialisierung bis zur Ausführung nahtlos integriert sind. Dieses Modul ist Teil des UFO Projekts.
Datenfluss
Dataflow nutzt UFO zur Implementierung von instantiation, execution und dataflow für eine gegebene Aufgabe, mit Optionen für Stapelverarbeitung und Einzelverarbeitung.
- Instantiation: Instantiation bezieht sich auf den Prozess der Einrichtung und Vorbereitung einer Aufgabe zur Ausführung. Dieser Schritt beinhaltet typischerweise das
Auswählen einer Vorlage,PrefillundFilter. - Execution: Execution ist der eigentliche Prozess der Ausführung der Aufgabe. Dieser Schritt beinhaltet die Durchführung der durch die
Instantiationspezifizierten Aktionen oder Operationen. Nach der Ausführung wird ein Bewertungsagent die Qualität des gesamten Ausführungsprozesses bewerten. - Dataflow: Dataflow ist der übergreifende Prozess, der Instantiation und Execution zu einer einzigen Pipeline kombiniert. Er bietet eine End-to-End-Lösung für die Verarbeitung von Aufgaben und stellt sicher, dass alle notwendigen Schritte (von der Initialisierung bis zur Ausführung) nahtlos integriert sind.
Sie können instantiation und execution unabhängig voneinander verwenden, wenn Sie nur einen bestimmten Teil des Prozesses durchführen müssen. Wenn beide Schritte für eine Aufgabe erforderlich sind, optimiert der dataflow Prozess diese und ermöglicht Ihnen, Aufgaben von Anfang bis Ende in einer einzigen Pipeline auszuführen.
Die gesamte Verarbeitung des Dataflows ist wie folgt. Gegeben sind Task-Plan-Daten, die LLM werden Task-Aktionsdaten instantiieren, einschließlich der Auswahl einer Vorlage, Prefill und Filter.
Anwendung
1. Pakete installieren
Sie sollten die notwendigen Pakete im UFO-Root-Ordner installieren.
pip install -r requirements.txt
2. LLMs konfigurieren
Bevor Sie Dataflow ausführen, müssen Sie Ihre LLM-Konfigurationen individuell für PrefillAgent und FilterAgent angeben. Sie können Ihre eigene Konfigurationsdatei dataflow/config/config.yaml erstellen, indem Sie dataflow/config/config.yaml.template kopieren und die Konfiguration für PREFILL_AGENT und FILTER_AGENT wie folgt bearbeiten:
OpenAI
VISUAL_MODE: True, # Whether to use the visual mode
API_TYPE: "openai" , # The API type, "openai" for the OpenAI API.
API_BASE: "https://api.openai.com/v1/chat/completions", # The the OpenAI API endpoint.
API_KEY: "sk-", # The OpenAI API key, begin with sk-
API_VERSION: "2024-02-15-preview", # "2024-02-15-preview" by default
API_MODEL: "gpt-4-vision-preview", # The only OpenAI model
Azure OpenAI (AOAI)
VISUAL_MODE: True, # Whether to use the visual mode
API_TYPE: "aoai" , # The API type, "aoai" for the Azure OpenAI.
API_BASE: "YOUR_ENDPOINT", # The AOAI API address. Format: https://{your-resource-name}.openai.azure.com
API_KEY: "YOUR_KEY", # The aoai API key
API_VERSION: "2024-02-15-preview", # "2024-02-15-preview" by default
API_MODEL: "gpt-4-vision-preview", # The only OpenAI model
API_DEPLOYMENT_ID: "YOUR_AOAI_DEPLOYMENT", # The deployment id for the AOAI API
Sie können auch nicht-visuelle Modelle (z. B. GPT-4) für jeden Agenten verwenden, indem Sie VISUAL_MODE: False und die entsprechenden API_MODEL (openai) und API_DEPLOYMENT_ID (aoai) einstellen.
Nicht-visuelle Modellkonfiguration
Sie können nicht-visuelle Modelle (z. B. GPT-4) für jeden Agenten verwenden, indem Sie die folgenden Einstellungen in der Datei config.yaml konfigurieren:
VISUAL_MODE: False # Um den nicht-visuellen Modus zu aktivieren.- Geben Sie das entsprechende
API_MODEL(OpenAI) undAPI_DEPLOYMENT_ID(AOAI) für jeden Agenten an.
Stellen Sie sicher, dass Sie diese Einstellungen korrekt konfigurieren, um nicht-visuelle Modelle effektiv zu nutzen.
Weitere Konfigurationen
config_dev.yaml gibt die Pfade relevanter Dateien an und enthält Standardeinstellungen. Die Abgleichstrategie für den Fensterabgleich und den Steuerfilter unterstützt Optionen: 'contains', 'fuzzy' und 'regex', was flexible Abgleichstrategien für Benutzer ermöglicht. MAX_STEPS ist die maximale Schrittanzahl für die Ausführung des Flows, die vom Benutzer eingestellt werden kann.
Hinweis
Die spezifische Implementierung und die Aufrufmethode der Abgleichstrategie finden Sie unter windows_app_env.
Hinweis
VORSICHT! Wenn Sie GitHub oder andere Open-Source-Tools verwenden, setzen Sie Ihre config.yaml nicht online, da sie Ihre privaten Schlüssel enthält.
3. Dateien vorbereiten
Bestimmte Dateien müssen vor der Ausführung der Aufgabe vorbereitet werden.
3.1. Aufgaben als JSON
Die zu instanziierenden Aufgaben müssen in einem Ordner mit JSON-Dateien organisiert werden. Der Standardordnerpfad ist auf dataflow/tasks eingestellt. Dieser Pfad kann in der Datei dataflow/config/config.yaml geändert werden, oder Sie können ihn im Terminal angeben, wie in 4. Start Running erwähnt. Zum Beispiel könnte eine Aufgabe, die in dataflow/tasks/prefill/ gespeichert ist, wie folgt aussehen:
{
// The app you want to use
"app": "word",
// A unique ID to distinguish different tasks
"unique_id": "1",
// The task and steps to be instantiated
"task": "Type 'hello' and set the font type to Arial",
"refined_steps": [
"Type 'hello'",
"Set the font to Arial"
]
}
3.2. Vorlagen und Beschreibungen
Sie sollten eine App-Datei als Referenz für die Instanziierung in einem Ordner ablegen, der nach der App benannt ist.
Zum Beispiel, wenn Sie template1.docx für Word haben, sollte es sich unter dataflow/templates/word/template1.docx befinden.
Zusätzlich sollte für jeden App-Ordner eine Datei description.json unter dataflow/templates/word/description.json vorhanden sein, die jede Vorlagendatei detailliert beschreibt. Sie könnte wie folgt aussehen:
{
"template1.docx": "A document with a rectangle shape",
"template2.docx": "A document with a line of text"
}
Wenn eine Datei description.json nicht vorhanden ist, wird eine Vorlagendatei zufällig ausgewählt.
3.3. Finale Struktur
Stellen Sie sicher, dass die folgenden Dateien vorhanden sind:
- Zu instanziierende JSON-Dateien
- Vorlagen als Referenzen für die Instanziierung
- Beschreibungsdatei im JSON-Format
Die Struktur der Dateien kann wie folgt sein:
dataflow/
|
├── tasks
│ └── prefill
│ ├── bulleted.json
│ ├── delete.json
│ ├── draw.json
│ ├── macro.json
│ └── rotate.json
├── templates
│ └── word
│ ├── description.json
│ ├── template1.docx
│ ├── template2.docx
│ ├── template3.docx
│ ├── template4.docx
│ ├── template5.docx
│ ├── template6.docx
│ └── template7.docx
└── ...
4. Starten der Ausführung
Nachdem die vorherigen Schritte abgeschlossen sind, können Sie die folgenden Befehle in der Befehlszeile verwenden. Wir bieten Einzel-/Stapelverarbeitung an, für die Sie den Pfad der einzelnen Datei / des Ordnerpfads angeben müssen. Bestimmen Sie den vom Benutzer bereitgestellten Pfadtyp und entscheiden Sie automatisch, ob eine einzelne Aufgabe oder mehrere Aufgaben verarbeitet werden.
Außerdem können Sie wählen, ob Sie die Abschnitte instantiation / execution einzeln verwenden oder sie als ganzen Abschnitt, der als dataflow bezeichnet wird, verwenden.
Der Standard-Task-Hub ist in dataflow/config_dev.yaml als "TASKS_HUB" festgelegt.
- Dataflow-Aufgabe
python -m dataflow -dataflow --task_path path_to_task_file
- Instanziierungsaufgabe
python -m dataflow -instantiation --task_path path_to_task_file
- Ausführungsaufgabe
python -m dataflow -execution --task_path path_to_task_file
Hinweis
- Benutzer sollten vorsichtig sein, die Originaldateien bei der Verwendung dieses Projekts zu speichern, andernfalls werden die Dateien geschlossen, wenn die Anwendung beendet wird.
- Nach dem Start des Projekts sollten Benutzer das Anwendungsfenster nicht schließen, während das Programm Screenshots macht.
Arbeitsablauf
Instanziierung
Es gibt drei wichtige Schritte im Instanziierungsprozess:
Auswahl einer VorlageDatei entsprechend der angegebenen App und Anweisung.Prefillder Aufgabe unter Verwendung des aktuellen Screenshots.Filterder erstellten Aufgabe.
Gegeben die initiale Aufgabe wählt der Dataflow zuerst eine Vorlage (Phase 1), dann füllt er die initiale Aufgabe basierend auf der Word-Umgebung vor, um Task-Aktionsdaten zu erhalten (Phase 2). Schließlich filtert er die erstellte Aufgabe, um die Qualität der Task-Aktionsdaten zu bewerten (Phase 3).
Hinweis
Die detailliertere Code-Design-Dokumentation für die Instanziierung finden Sie unter instantiation.
Ausführung
Die instanziierten Pläne werden von einer Ausführungsaufgabe ausgeführt. Nach der Ausführung bewertet ein Bewertungsagent die Qualität des gesamten Ausführungsprozesses.
Hinweis
Die detailliertere Code-Design-Dokumentation für die Ausführung finden Sie unter execution.
Ergebnis
Die Ergebnisse werden im Verzeichnis results\ unter instantiation, execution und dataflow gespeichert und werden weiter in Unterverzeichnissen basierend auf den Ausführungsergebnissen gespeichert.
Hinweis
Detailliertere Informationen zu den Ergebnissen finden Sie unter result.
Schnellstart
Wir bereiten zwei Fälle vor, um den Dataflow zu demonstrieren, die sich unter dataflow\tasks\prefill befinden. Nach der Installation der erforderlichen Pakete können Sie den folgenden Befehl in der Befehlszeile eingeben:
python -m dataflow -dataflow
Und Sie können die Hinweise im Terminal sehen, was bedeutet, dass der Dataflow funktioniert.
Struktur der zugehörigen Dateien
Nachdem die beiden Aufgaben abgeschlossen sind, erscheinen die Aufgaben- und Ausgabedateien wie folgt:
UFO/
├── dataflow/
│ └── results/
│ ├── saved_document/ # Directory for saved documents
│ │ ├── bulleted.docx # Result of the "bulleted" task
│ │ └── rotate.docx # Result of the "rotate" task
│ ├── dataflow/ # Dataflow results directory
│ │ ├── execution_pass/ # Successfully executed tasks
│ │ │ ├── bulleted.json # Execution result for the "bulleted" task
│ │ │ ├── rotate.json # Execution result for the "rotate" task
│ │ │ └── ...
└── ...
Die spezifischen Ergebnisse können in result im JSON-Format zusammen mit Beispieldaten referenziert werden.
Log-Dateien
Die entsprechenden Logs finden Sie in den Verzeichnissen logs/bulleted und logs/rotate, wie unten gezeigt. Detaillierte Logs für jeden Workflow werden aufgezeichnet und erfassen jeden Schritt des Ausführungsprozesses.
Referenz
AppEnum
Basiert auf: Enum
Enum-Klasse für Anwendungen.
Initialisiert die Anwendungs-Enum.
| Parameter |
|
|---|
Quellcode in dataflow/data_flow_controller.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 | |
TaskObject
Initialisiert das Aufgabenobjekt.
| Parameter |
|
|---|
Quellcode in dataflow/data_flow_controller.py
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 | |
DataFlowController
Flow-Controller-Klasse zur Verwaltung des Instanziierungs- und Ausführungsprozesses.
Initialisiert den Flow-Controller.
| Parameter |
|
|---|
Quellcode in dataflow/data_flow_controller.py
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | |
instantiated_plan property writable
Ruft den instanziierten Plan aus den Aufgabeninformationen ab.
| Rückgabe |
|
|---|
template_copied_path property
Ruft den kopierten Vorlagenpfad aus den Aufgabeninformationen ab.
| Rückgabe |
|
|---|
execute_execution(request, plan)
Führt den Ausführungsprozess aus.
| Parameter |
|
|---|
Quellcode in dataflow/data_flow_controller.py
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | |
execute_instantiation()
Führt den Instanziierungsprozess aus.
| Rückgabe |
|
|---|
Quellcode in dataflow/data_flow_controller.py
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 | |
init_task_info()
Initialisiert die Aufgabeninformationen.
| Rückgabe |
|
|---|
Quellcode in dataflow/data_flow_controller.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | |
instantiation_single_flow(flow_class, flow_type, init_params=None, execute_params=None)
Führt einen einzelnen Flow-Prozess in der Instanziierungsphase aus.
| Parameter |
|
|---|
| Rückgabe |
|
|---|
Quellcode in dataflow/data_flow_controller.py
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | |
reformat_to_batch(path)
Überträgt das Ergebnis in den Ergebnis-Hub.
Quellcode in dataflow/data_flow_controller.py
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 | |
run()
Führt den Instanziierungs- und Ausführungsprozess aus.
Quellcode in dataflow/data_flow_controller.py
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 | |
save_result()
Validiert und speichert das Ergebnis der instanziierten Aufgabe.
Quellcode in dataflow/data_flow_controller.py
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 | |