From d63044ea47182501180c5c50f47db6016c585667 Mon Sep 17 00:00:00 2001 From: Lee Spector Date: Tue, 28 Mar 2023 23:00:35 -0400 Subject: [PATCH] Update docs --- docs/A_Guide_To_Propeller.html | 4 ++-- docs/Adding_Genetic_Operators.html | 2 +- docs/Adding_Problem.html | 2 +- docs/Adding_Selection_Method.html | 2 +- docs/Additional_Instructions.html | 2 +- docs/Generating_Documentation.html | 2 +- docs/index.html | 14 +++++++++++--- docs/propeller.genome.html | 2 +- docs/propeller.gp.html | 2 +- docs/propeller.problems.PSB2.basement.html | 4 ++-- docs/propeller.problems.PSB2.bouncing-balls.html | 4 ++-- docs/propeller.problems.PSB2.bowling.html | 4 ++-- docs/propeller.problems.PSB2.camel-case.html | 4 ++-- docs/propeller.problems.PSB2.dice-game.html | 4 ++-- docs/propeller.problems.PSB2.fizz-buzz.html | 4 ++-- docs/propeller.problems.PSB2.fuel-cost.html | 4 ++-- docs/propeller.problems.PSB2.gcd.html | 4 ++-- docs/propeller.problems.PSB2.luhn.html | 4 ++-- docs/propeller.problems.PSB2.middle-character.html | 4 ++-- docs/propeller.problems.PSB2.paired-digits.html | 4 ++-- docs/propeller.problems.PSB2.shopping-list.html | 4 ++-- docs/propeller.problems.PSB2.snow-day.html | 4 ++-- docs/propeller.problems.PSB2.solve-boolean.html | 4 ++-- docs/propeller.problems.PSB2.spin-words.html | 4 ++-- docs/propeller.problems.PSB2.square-digits.html | 4 ++-- ...ropeller.problems.PSB2.substitution-cipher.html | 4 ++-- docs/propeller.problems.PSB2.twitter.html | 4 ++-- docs/propeller.problems.simple-regression.html | 6 +++--- docs/propeller.problems.software.number-io.html | 4 ++-- docs/propeller.problems.software.smallest.html | 4 ++-- docs/propeller.problems.string-classification.html | 4 ++-- docs/propeller.problems.valiant.html | 4 ++-- docs/propeller.push.instructions.bool.html | 2 +- docs/propeller.push.instructions.character.html | 2 +- docs/propeller.push.instructions.code.html | 2 +- docs/propeller.push.instructions.html | 2 +- docs/propeller.push.instructions.input-output.html | 2 +- docs/propeller.push.instructions.numeric.html | 2 +- docs/propeller.push.instructions.polymorphic.html | 2 +- docs/propeller.push.instructions.string.html | 2 +- docs/propeller.push.instructions.vector.html | 2 +- docs/propeller.push.interpreter.html | 2 +- docs/propeller.push.limits.html | 2 +- docs/propeller.push.state.html | 2 +- docs/propeller.selection.html | 2 +- docs/propeller.simplification.html | 2 +- docs/propeller.tools.calculus.html | 2 +- docs/propeller.tools.character.html | 2 +- docs/propeller.tools.distributions.html | 2 +- docs/propeller.tools.math.html | 2 +- docs/propeller.tools.metrics.html | 2 +- docs/propeller.utils.html | 2 +- docs/propeller.variation.html | 2 +- src/docs_src/Additional_Instructions.md | 3 +++ 54 files changed, 91 insertions(+), 80 deletions(-) diff --git a/docs/A_Guide_To_Propeller.html b/docs/A_Guide_To_Propeller.html index fd23bc8..7d4dafc 100644 --- a/docs/A_Guide_To_Propeller.html +++ b/docs/A_Guide_To_Propeller.html @@ -1,6 +1,6 @@ -A Guide to Propeller

Project

Topics

Namespaces

A Guide to Propeller

+A Guide to Propeller

Project

Topics

Namespaces

A Guide to Propeller

Propeller is an implementation of the Push programming language and the PushGP genetic programming system in Clojure.

For more information on Push and PushGP see http://pushlanguage.org.

Overview

@@ -31,7 +31,7 @@

You can evolve a Push program to solve a problem. You can also use the Push interpreter to evaluate Push programs in other projects, for example in agent-based evolutionary simulations in which agents are controlled by evolving Push programs.

Installation

If you have installed leiningen, which is a tool for running Clojure programs, then you can run Propeller on a genetic programming problem that is defined within this project from the command line with the command lein run -m <namespace>, replacing <namespace> with the actual namespace that you will find at the top of the problem file.

-

If you have installed Clojure, you can run Propeller on a genetic programming problem with the command clj --main <namespace>, replacing <namespace> with the actual namespace that you will find at the top of the problem file. The examples below use leiningen, but you can replace lein run -m with clj --main to run the same problem.

+

If you have installed Clojure, you can run Propeller on a genetic programming problem with the command clj -M -m <namespace>, replacing <namespace> with the actual namespace that you will find at the top of the problem file. The examples below use leiningen, but you can replace lein run -m with clj -M -m to run the same problem.

A specific example is provided later below.

How do I run Propeller on a problem?

To run Propeller on a problem, you want to call the -main function in the problem file using leiningen. The -main function will create a map of arguments from the input and run the main genetic programming loop.

diff --git a/docs/Adding_Genetic_Operators.html b/docs/Adding_Genetic_Operators.html index 5d572c1..15000b2 100644 --- a/docs/Adding_Genetic_Operators.html +++ b/docs/Adding_Genetic_Operators.html @@ -1,6 +1,6 @@ -Adding Genetic Operators

Project

Topics

Namespaces

Adding Genetic Operators

+Adding Genetic Operators

Project

Topics

Namespaces

Adding Genetic Operators

In addition to the already-included genetic operators, you can add your own!

Variation Genetic Operators

    diff --git a/docs/Adding_Problem.html b/docs/Adding_Problem.html index ac75452..afdae03 100644 --- a/docs/Adding_Problem.html +++ b/docs/Adding_Problem.html @@ -1,6 +1,6 @@ -Adding a Problem

    Project

    Topics

    Namespaces

    Adding a Problem

    +Adding a Problem

    Project

    Topics

    Namespaces

    Adding a Problem

    In general, a problem file has 3 components: train-and-test-data, instructions, error-function, and -main.

    1. To add a new problem, you need training and test data. For Problem Synthesis Benchmark Problems (PSB2), you can fetch datasets using psb2.core/fetch-examples.
      2. diff --git a/docs/Adding_Selection_Method.html b/docs/Adding_Selection_Method.html index d380eed..25c38cc 100644 --- a/docs/Adding_Selection_Method.html +++ b/docs/Adding_Selection_Method.html @@ -1,6 +1,6 @@ -Adding a Selection Method

      Project

      Topics

      Namespaces

      Adding a Selection Method

      +Adding a Selection Method

      Project

      Topics

      Namespaces

      Adding a Selection Method

      1. Define a selection method function in propeller.selection that selects an individual from the population
      2. Add the selection method in propeller.selection/select-parent under the case call:
        3. diff --git a/docs/Additional_Instructions.html b/docs/Additional_Instructions.html index c2fe3b9..81cffa7 100644 --- a/docs/Additional_Instructions.html +++ b/docs/Additional_Instructions.html @@ -1,6 +1,6 @@ -Additional Instructions

        Project

        Topics

        Namespaces

        Table of contents

        +Additional Instructions

        Project

        Topics

        Namespaces

        Table of contents