O.G.A.S. Русский

Getting started

The short way from installing to your first program: how to start the platform, what is where in the workshop, how to build a program by hand and how to give it to the assistant, what to do when something goes wrong. Every window is described in detail in The workshop.

1 What O.G.A.S. is

O.G.A.S. is a platform on which a person builds programs for themselves. A program has two parts:

A module is a step that cannot be built of nodes: a neural network, reading a file, asking a service on the network. Modules are written in Python or Rust; ready ones are taken in the library.

Programs are built in the workshop — the window of the platform. A program that is built is switched on and works until it is switched off: it waits for presses, messages, time. One run is one piece of work of the program, from an event to its end.

2 Installing and starting

2.1 What is needed

The installer ogas-setup-<version>.exe from ogas.space leads through three stages — running nothing until you press «Check» or another button of a check, and showing each command with its answer; each stage has its own summary of what will be done and the journal at the bottom of the window: WSL and Linux — a check of virtualization (off — how to turn it on), WSL when it is not there, and the Linux for the platform: one that is here or its own «OGAS» on the chosen disk, with the name and the password you set right there, and the updates of WSL and Linux — when the newest is there, it is said: «the latest version»; packages of Linux — what each group gives and how much room it takes, what is installed already; O.G.A.S. — the folder in Linux, the shortcut «O.G.A.S.». During the setup the password is not asked, later sudo asks it. When O.G.A.S. is installed already — update it, install it anew or change the set of packages (Building, installing and maintenance, 2.1).

How to build the platform from its sources and what a delivery holds — Building, installing and maintenance.

2.2 Starting

From Windows — the shortcut «O.G.A.S.» in «Start» or on the desktop; a platform built from the sources — a double click on ogas.cmd. No window of the console stays: the shortcut and ogas.cmd start the platform through the starter ogas-start.exe; without it (the workshop not built) ogas.cmd keeps the console open, and the errors of the start are seen in it. From WSL — in the folder of the platform:

./ogas

The platform comes up and opens the workshop. Until it answers, the window says «Connecting…». A closed window goes to the icon by the clock, and the platform works on: programs that are on wait for their events. «Leave» in the menu of the icon, or the sign of leaving in the workshop, stop the platform.

Starting the shortcut again while the platform works does not start a second platform: it opens the window again.

To check that everything is in place, before starting:

./ogas doctor

The check names what is missing: the window program, starting Windows programs from WSL, Python, the video card.

2.3 A program without the workshop

A ready program is opened straight in its own window, without the workshop:

./ogas program --process <id of the program>

From Windows — ogas.cmd program --process <id>, or a shortcut of the program with the same words at the end of its command line.

To run a program once and get its answer in the command line:

./ogas run --process <id of the program> --text "what to give it"

The command switches the program on, gives the text to its event, waits for the run to end and stops the platform; exit code 0 — the run went through.

3 The workshop at a glance

Along the edges of the window are bars; in the middle are the windows opened from them.

On the left — two bars:

On the right — your bars of programs: which there are, what they are called and which programs stand on them, you decide in the library; a click on an icon opens the program.

Every window is made the same way: on the left a column — what can be chosen or placed; on the right the work area; what is chosen in it opens in a panel over the lower part of the area. Windows are moved and resized; a folded window lies as a capsule in the bottom bar.

Several programs can be open at once: each has its own windows, and the tab of a window names its program.

4 A first program

Let us build the program «Hello»: a field for a name, a button, and under them the answer «Hello, !».

  1. Create. On the «Workshop» bar — «Create», name «Hello». The graph window of the new program opens.
  2. Variables. In the column of the graph make two text variables: name — the name, said — the answer. A variable is a place where the program keeps a value; the pulpit shows it and changes it.
  3. Event. Put an «Event» node from the column on the canvas and choose the source «Pulpit» in its panel: such a node starts a run when a button is pressed on the pulpit.
  4. The answer. Put a «Template» node and write Hello, {name}! in it: in braces is a field of the data that came into the node; the button brings the name (step 7). The template adds the field text with the ready answer to the data. Put a «Write» node and choose the variable said and the field text in it.
  5. Links. Draw a link from the output of the event to the input of the template, and from the output of the template to the input of the write. A port the link may go to glows green; one it may not, red, and the window says why.
  6. Validate and save. «Validate» names what is wrong in the graph; «Save» writes the program. Only a graph that passed the check is saved.
  7. The pulpit. Open «Pulpit setup». Put a field and bind it to name; a button — to the event, and let it carry name with it: the press puts the value of the variable into the data of the run; a «Value» — to said. Label them: «Name», «Say hello», «Answer». «Save».
  8. Switch on and run. In the graph window — «Switch on». Type a name into the field of the pulpit and press the button. The answer appears under them.

What each kind of node does, its inputs, outputs and settings — Kinds of nodes. A ready program is put on your bar on the right in the library: the bar has a «+» button.

5 The assistant

The assistant builds programs and modules from a task written in words. A neural network you connect thinks for it — by API or on this computer.

5.1 Connecting a network

«Assistant» → «Network of the assistant». Choose a network:

The bigger the network, the better it builds programs. Small local networks manage simple things and often say «done» having done nothing; the assistant notices it, reminds the network, and the panel says honestly that nothing was written.

5.2 Giving a task

Write what is needed and press «Send» (or Ctrl+Enter). Under your words you see what the assistant does: looks at the kinds of nodes, makes a draft, writes the graph, checks it. Each action is marked: ✓ — it went, ✗ — it was refused; the pointer held over it shows the details. When the assistant has finished, it says what it made and how to use it; answer it or ask for more in the same field.

5.3 What the assistant may do

Whatever the access, the assistant does not read keys and secrets, does not change the settings of the platform and deletes nothing.

6 Modules and neural networks

The library is everything you have: programs, modules, neural networks, pieces of interface. There, too, are the sources they are downloaded from: the showcase ogas.space, Hugging Face, Civitai and other showcases. A thing from an unchecked showcase asks for trust before it is installed — every time.

A neural network is one for all the modules that take it: the file or folder of the network is put into the subfolder of its kind in the folder of networks the library shows. Which network a node takes is chosen in its panel.

The environment. A module in Python with packages needs the environment of its program: «Modules» → «Install the environment». The platform installs nothing by itself — only by this button. Before the first installation the workshop warns: a module works with your rights, it has no sandbox.

Your own module is made in the library — «Create a module» — or by a command of OGAS SDK; how to write it — OGAS SDK. Someone else's module is accepted in the library: «Take a module in» shows what it brings and installs it after the question of trust.

7 Switching on, running, stopping

What a run left — files, pictures, sound — is in the tab «Results» of its row in the «Program journal». «Open» opens a file with its Windows program, «Show in folder» shows it in Explorer; programs and scripts are not opened, only shown in their folder.

8 When something is wrong

Table 1 — What you see and what it means

What you see What it means What to do
«Connecting…» does not go away the platform did not come up run ./ogas doctor, look at what is missing
«No connection to the platform» under the top bar the connection of the window to the platform broke start the shortcut again — the window opens anew
a window marked «unavailable» a part of the platform the window uses does not work look at the problem in the «Platform journal»; the rest works
a node blinks the program waits for your answer, or the node failed answer on the pulpit, or open the reason in the panel of the node
«The files of the module changed» the module was edited after the program was saved save the program again
a request to confirm a retry the outcome of the step is unknown look at what the module managed to do and decide yourself

9 Settings

«Settings» — on the left the «State» of the platform and the sections, on the right the settings of a section; a value is changed in the panel of the chosen setting, and «?» beside it explains it. What each setting does — Settings.

The door for programs («Other settings» → «Door for programs») lets your programs — OGAS SDK scripts, editors — work with the platform. It is closed until you open it; a program comes in by the key, which can be shown, copied or made anew right there. With the key a program can do in the platform everything you do in the workshop, except stopping the platform and changing the door itself.