From f47d05e279a0555bca45d125c999c8d9ac15748c Mon Sep 17 00:00:00 2001 From: Ashley Bao Date: Thu, 26 Jan 2023 11:53:49 -0500 Subject: [PATCH] updated docs --- docs/A_Guide_To_Propeller.html | 6 ++++-- docs/Adding_Genetic_Operators.html | 2 +- docs/Adding_Problem.html | 4 ++-- docs/Adding_Selection_Method.html | 2 +- docs/Additional_Instructions.html | 2 +- docs/Generating_Documentation.html | 5 +++++ docs/index.html | 4 ++-- docs/propeller.genome.html | 2 +- docs/propeller.gp.html | 2 +- docs/propeller.problems.PSB2.basement.html | 2 +- docs/propeller.problems.PSB2.bouncing-balls.html | 2 +- docs/propeller.problems.PSB2.bowling.html | 2 +- docs/propeller.problems.PSB2.camel-case.html | 2 +- docs/propeller.problems.PSB2.dice-game.html | 2 +- docs/propeller.problems.PSB2.fizz-buzz.html | 2 +- docs/propeller.problems.PSB2.fuel-cost.html | 2 +- docs/propeller.problems.PSB2.gcd.html | 2 +- docs/propeller.problems.PSB2.luhn.html | 2 +- docs/propeller.problems.PSB2.middle-character.html | 2 +- docs/propeller.problems.PSB2.paired-digits.html | 2 +- docs/propeller.problems.PSB2.shopping-list.html | 4 ++-- docs/propeller.problems.PSB2.snow-day.html | 2 +- docs/propeller.problems.PSB2.solve-boolean.html | 2 +- docs/propeller.problems.PSB2.spin-words.html | 2 +- docs/propeller.problems.PSB2.square-digits.html | 2 +- docs/propeller.problems.PSB2.substitution-cipher.html | 2 +- docs/propeller.problems.PSB2.twitter.html | 2 +- docs/propeller.problems.simple-regression.html | 2 +- docs/propeller.problems.software.number-io.html | 2 +- docs/propeller.problems.software.smallest.html | 2 +- docs/propeller.problems.string-classification.html | 2 +- docs/propeller.problems.valiant.html | 2 +- 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/A_Guide_To_Propeller.md | 4 ++++ src/docs_src/Adding_Problem.md | 2 +- .../docs_src/Generating_Documentation.md | 2 +- src/propeller/problems/PSB2/shopping_list.cljc | 9 +++++---- 57 files changed, 74 insertions(+), 62 deletions(-) create mode 100644 docs/Generating_Documentation.html rename Generating_Documentation.md => src/docs_src/Generating_Documentation.md (87%) diff --git a/docs/A_Guide_To_Propeller.html b/docs/A_Guide_To_Propeller.html index 8f1b3a1..fd23bc8 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

@@ -34,7 +34,7 @@

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.

A specific example is provided later below.

How do I run Propeller on a problem?

-

To run a problem in Propeller, 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.

+

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.

Below is the general format to run a problem through the command-line:

lein run -m [namespace of the problem file you want to test]
@@ -116,10 +116,12 @@
  • Adding genetic operators
  • Adding selection methods
  • Adding a new problem
    • +
  • Generating Documentation

    • Contributing

    You can report a bug on the GitHub issues page.

    The best way to contribute to Propeller is to fork the main GitHub repository and submit a pull request.

    +

    Propeller provides a way to automatically generate documentation for any contributions you might make.

    License

    Eclipse Public License 2.0

    This commercially-friendly copyleft license provides the ability to commercially license binaries; a modern royalty-free patent license grant; and the ability for linked works to use other licenses, including commercial ones.

    diff --git a/docs/Adding_Genetic_Operators.html b/docs/Adding_Genetic_Operators.html index 76c2356..5d572c1 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 d4f9e9d..ac75452 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. @@ -22,7 +22,7 @@ [datasets-directory problem-name n-train n-test] -
      2. Define the possible Push instructions to be used to create plushys. It should be a non-lazy list of instructions from push/instructions
        3. +
      3. Define the possible Push instructions to be used to create plushys. It should be a non-lazy list of instructions from push/instructions, input instructions, close, and constants (including functions that produce constants).
      4. Define an error function that will evaluate plushys and add :behaviors parsed-outputs, :errors, and :total-error to the individual
      5. Define the function -main with a map of default arguments.
      diff --git a/docs/Adding_Selection_Method.html b/docs/Adding_Selection_Method.html index f208876..d380eed 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 853d97a..c2fe3b9 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