Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
dynare
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Stéphane Adjemian
dynare
Commits
dc5f9a45
Verified
Commit
dc5f9a45
authored
1 year ago
by
Willi Mutschler
Committed by
Sébastien Villemot
1 year ago
Browse files
Options
Downloads
Patches
Plain Diff
doc: clarify SingleCompThread option
[skip ci] (cherry picked from commit
2c2d93f3
)
parent
172a9598
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/manual/source/the-configuration-file.rst
+16
-9
16 additions, 9 deletions
doc/manual/source/the-configuration-file.rst
with
16 additions
and
9 deletions
doc/manual/source/the-configuration-file.rst
+
16
−
9
View file @
dc5f9a45
...
@@ -54,7 +54,7 @@ conventions such as ``USER_NAME`` have been excluded for concision):
...
@@ -54,7 +54,7 @@ conventions such as ``USER_NAME`` have been excluded for concision):
``PATH_AND_FILE``
``PATH_AND_FILE``
Indicates a valid path to a file in the underlying operating
Indicates a valid path to a file in the underlying operating
system (e.g. ``/usr/local/MATLAB/R20
10
b/bin/matlab``).
system (e.g. ``/usr/local/MATLAB/R20
23
b/bin/matlab``).
``BOOLEAN``
``BOOLEAN``
...
@@ -270,20 +270,27 @@ lines starting with a hashtag (#).
...
@@ -270,20 +270,27 @@ lines starting with a hashtag (#).
.. option:: MatlabOctavePath = PATH_AND_FILE
.. option:: MatlabOctavePath = PATH_AND_FILE
The path to the MATLAB or Octave executable. The default value
The path to the MATLAB or Octave executable. The default value
is ``matlab`` as MATLAB
'
s executable is typically in the %PATH% environment
is ``matlab`` as MATLAB
’
s executable is typically in the %PATH% environment
variable. When using full paths on Windows, you may need to enclose the path
variable. When using full paths on Windows, you may need to enclose the path
in quoted strings, e.g. ``MatlabOctavePath="C:\Program Files\MATLAB\R2023
a
\bin\matlab.exe"``
in quoted strings, e.g. ``MatlabOctavePath="C:\Program Files\MATLAB\R2023
b
\bin\matlab.exe"``
.. option:: NumberOfThreadsPerJob = INTEGER
.. option:: NumberOfThreadsPerJob = INTEGER
For Windows nodes, sets the number of threads assigned to each
Sets the number of threads assigned to each remote MATLAB/Octave run.
remote MATLAB/Octave run. The default value is 1.
Needs to be an exact divisor of the number :opt:`CPUnbr <CPUnbr = INTEGER | [INTEGER:INTEGER]>` of cores.
Particularly, for very large models setting the number of threads per job to 2 might be the faster choice,
but this depends on your hardware, model and estimation task, so you should experiment with different values.
The default value is ``1``, see also related option :opt:`SingleCompThread <SingleCompThread = BOOLEAN>`.
.. option:: SingleCompThread = BOOLEAN
.. option:: SingleCompThread = BOOLEAN
Whether or not to disable MATLAB’s native multithreading. The
Whether or not to disable MATLAB’s native multithreading.
default value is ``false``. Option meaningless under Octave.
The default value is ``false``. Option meaningless under Octave.
Note: By default, MATLAB tries to speed up calculations by spreading them out over your computer’s threads.
However, tests have shown that for certain tasks, like MCMC estimations, MATLAB’s attempt to multitask
can actually slow things down when parallel computing is turned on. Setting this option to ``true``
starts the additional instances of MATLAB in a single thread mode using MATLAB’s ``-singleCompThread`` startup option.
.. option:: OperatingSystem = OPERATING_SYSTEM
.. option:: OperatingSystem = OPERATING_SYSTEM
The operating system associated with a node. Only necessary
The operating system associated with a node. Only necessary
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment