MilesCranmer commited on
Commit
fef663e
1 Parent(s): 29c2ee2

Describe cycles per iteration

Browse files
Files changed (1) hide show
  1. docs/options.md +16 -0
docs/options.md CHANGED
@@ -7,6 +7,7 @@ Some configurable features and options in `PySR` which you
7
  may find useful include:
8
  - `binary_operators`, `unary_operators`
9
  - `niterations`
 
10
  - `procs`
11
  - `populations`
12
  - `weights`
@@ -55,6 +56,21 @@ This is the total number of generations that `pysr` will run for.
55
  I usually set this to a large number, and exit when I am satisfied
56
  with the equations.
57
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
58
  ## Processors
59
 
60
  One can adjust the number of workers used by Julia with the
 
7
  may find useful include:
8
  - `binary_operators`, `unary_operators`
9
  - `niterations`
10
+ - `ncyclesperiteration`
11
  - `procs`
12
  - `populations`
13
  - `weights`
 
56
  I usually set this to a large number, and exit when I am satisfied
57
  with the equations.
58
 
59
+ ## Cycles per iteration
60
+
61
+ Each cycle considers every 10-equation subsample (re-sampled for each individual 10,
62
+ unless `fast_cycle` is set in which case the subsamples are separate groups of equations)
63
+ a single time, producing one mutated equation for each.
64
+ The parameter `ncyclesperiteration` defines how many times this
65
+ occurs before the equations are compared to the hall of fame,
66
+ and new equations are migrated from the hall of fame, or from other populations.
67
+ It also controls how slowly annealing occurs. You may find that increasing
68
+ `ncyclesperiteration` results in a higher cycles-per-second, as the head
69
+ worker needs to reduce and distribute new equations less often, and also increases
70
+ diversity. But at the same
71
+ time, a smaller number it might be that migrating equations from the hall of fame helps
72
+ each population stay closer to the best current equations.
73
+
74
  ## Processors
75
 
76
  One can adjust the number of workers used by Julia with the