User Guide

From emergent
Jump to: navigation, search
Crystal Clear app display.png Using emergent

This user guide is just a master index into a set of individual pages describing all of the key elements of the software. The software is object oriented, and this documentation is organized around the objects involved. See the guide to using emergent for other ways of accessing this information.

Emergent Logo
Main User Docs

Major Objects

These are the main entities you will interact with in constructing a simulation:

  • Project -- overall container for everything associated with a given simulation, including the Project window graphical interface.
  • DataTable -- multi-purpose container of all manner of data, including input patterns to present to a network, output recorded from the network, analysis, statistics, etc.
    • Grid View -- graphical view of data using text and colored squares in rows and columns
    • Graph View -- graphical view of data as lines or bars
  • Network -- the neural network itself
  • Program -- controls all aspects of the simulation
  • Containers -- List, Group and Matrix objects that are used everywhere to contain and manage other objects -- they form the skeleton of the project. See css list comprehension and Matrix css for powerful syntax within Programs to access these containers. in the Gui, they are accessed through the left browser and other similar browsers.

Other Objects and Functions

  • Preferences -- configure things just the way you want.
  • ControlPanel -- create a custom control panel for your simulation including all the main parameters and functions. Also can show a "diff" comparison of different objects.
  • Docs -- create project-specific documentation so others can take advantage of all your hard work!
  • DataProc -- specialized data processing functions, including data base, data analysis & statistics, data generation, image processing, and basic math operations.
  • Keyboard shortcuts -- become more efficient at using emergent by studying these
  • Virtual Environment -- uses ODE library http://ode.org/ to provide realistic physics simulation of a virtual world with which your network can interact.
  • Nogui run -- running your model in the background without the GUI active (e.g., for clusters or other "batch jobs")
  • Command line switches -- control the program from the command line
  • Environment variables -- environment variables that change the behavior of emergent
  • Network Algorithm Guide -- detailed info on the neural network algorithms
  • CSS -- the "C Super Script" scripting language that runs Programs and can be used directly at the Console or in user scripts.
  • UserData -- find out how to add your own persistent named data items to emergent objects
  • Server Protocol -- describes the TCP/IP interface for remotely running emergent programs, setting/fetching variables, and sending/receiving data
  • Plugins -- easily extend the software with new hard-coded C++ features (learning algorithms, data table functions, anything)