Skip to content

Commit

Permalink
update docs about purpose of default #proc=1
Browse files Browse the repository at this point in the history
  • Loading branch information
bquistorff committed Oct 17, 2023
1 parent c56c935 commit e264e5d
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
4 changes: 3 additions & 1 deletion ado/parallel.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,9 @@
<span class=result><u>s</u></span><span class=result>eeds</span> Numlist. With this option the user can pass an specific seed to be used within each child process.
<span class=result><u>randt</u></span><span class=result>ype</span> String. Tells parallel whether to use the current seed (-current-), the current datetime (-datetime-) or random.org API
(-random.org-) to generate the seeds for each child processes (please read the Description section).
<span class=result><u>proc</u></span><span class=result>essors</span> Integer. If running on StataMP, sets the number of processors each child process should use. Default value is 1.
<span class=result><u>proc</u></span><span class=result>essors</span> Integer. If running on StataMP, sets the number of processors each child process should use. Default value is 1, to help
avoid the sum total of Stata processes across child instances being more than the number of physical processors (which
can severly limit performance).
<span class=result><u>t</u></span><span class=result>imeout</span> Integer. If a child process hasn't started, how much time in seconds does <span class=result>parallel</span> has to wait until assume that there was
a connection error and thus the child process won't start. Default value is 60.
<span class=result><u>out</u></span><span class=result>putopts</span> A list of option names that are aggregating output options. <span class=result>parallel</span> automtically aggregates main data from child
Expand Down
3 changes: 2 additions & 1 deletion ado/parallel.sthlp
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,8 @@ used within each child process.{p_end}
(-current-), the current datetime (-datetime-) or random.org API (-random.org-) to
generate the seeds for each child processes (please read the Description section).{p_end}
{synopt:{opt proc:essors}}Integer. If running on StataMP, sets the number of processors
each child process should use. Default value is 1.{p_end}
each child process should use. Default value is 1, to help avoid the sum total of Stata processes across child instances
being more than the number of physical processors (which can severly limit performance).{p_end}
{synopt:{opt t:imeout}}Integer. If a child process hasn't started, how much time in seconds
does {cmd:parallel} has to wait until assume that there was a connection error and thus
the child process won't start. Default value is 60.{p_end}
Expand Down
2 changes: 1 addition & 1 deletion parallel.pkg
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ d KW: multiple imputations
d
d Requires: Stata version 14
d
d Distribution-Date: 20231017
d Distribution-Date: 20231018
d
d Authors: George Vega Yon , California Institute of Technology, USA
d Brian Quistorff, Bureau of Economic Analysis, USA
Expand Down

0 comments on commit e264e5d

Please sign in to comment.