MilesCranmer commited on
Commit
0dfee65
1 Parent(s): 18630d9

Describe issue with Jupyter in docs

Browse files
Files changed (1) hide show
  1. docs/tuning.md +4 -2
docs/tuning.md CHANGED
@@ -6,7 +6,9 @@ First, my general tips would be to avoid using redundant operators, like how `po
6
 
7
  When running PySR, I usually do the following:
8
 
9
- I run from IPython on the head node of a slurm cluster. Passing `cluster_manager="slurm"` will make PySR set up a run over the entire allocation. I set `procs` equal to the total number of cores over my entire allocation.
 
 
10
 
11
  1. Use the default parameters.
12
  2. Use only the operators I think it needs and no more.
@@ -43,4 +45,4 @@ Once a run is finished, I use the `PySRRegressor.from_file` function to load the
43
  ## More Tips
44
 
45
  You might also wish to explore the [discussions](https://github.com/MilesCranmer/PySR/discussions/) page for more tips, and to see if anyone else has had similar questions.
46
- Be sure to also read through the [reference](api.md).
 
6
 
7
  When running PySR, I usually do the following:
8
 
9
+ I run from IPython (Jupyter Notebooks don't work as well[^1]) on the head node of a slurm cluster. Passing `cluster_manager="slurm"` will make PySR set up a run over the entire allocation. I set `procs` equal to the total number of cores over my entire allocation.
10
+
11
+ [^1]: Jupyter Notebooks are supported by PySR, but miss out on some useful features available in IPython and Python: the progress bar, and early stopping with "q". In Jupyter you cannot interrupt a search once it has started; you have to restart the kernel. See [this issue](https://github.com/MilesCranmer/PySR/issues/260) for updates.
12
 
13
  1. Use the default parameters.
14
  2. Use only the operators I think it needs and no more.
 
45
  ## More Tips
46
 
47
  You might also wish to explore the [discussions](https://github.com/MilesCranmer/PySR/discussions/) page for more tips, and to see if anyone else has had similar questions.
48
+ Be sure to also read through the [reference](api.md).