Update documentation for web page #3411
Conversation
cmcantalupo
commented
Apr 23, 2024
cmcantalupo
commented
- Relates to Documentation updates #3385
- Read through all existing documentation and re-word/re-flow as necessary to match the new directory structure of the source repository.
- Documentation about things like "you MUST use the performance cpufreq governor" can be removed/relaxed. We're not just concerned with HPC anymore. Similarly, CPU affinity requirements.
- HPC specific doc would be nice that discusses CPU governors, rank-to-CPU affinity, OpenMP, MPI, etc.
cmcantalupo
force-pushed
the
release-3.0-docs
branch
from
6f33822
to
739261a
Compare
docs/source/requires.rst
Outdated
| system administrator. This feature is mandatory if the GEOPM Access Service is | ||
| not active on the system. Alternatively, the access can also be managed by the | ||
| system administrator using the GEOPM Access Service, if active. |
There was a problem hiding this comment.
I think the above paragraph could be reworked a bit. It should discuss the fact that allowlists in msr-safe are required in all usages now. It should also mention the allowlist generation capability of geopmaccess -s and why that's important.
Happy to take a crack at that later.
There was a problem hiding this comment.
Also the logging feature in geopmaccess for the minimal list.
docs/source/runtime.rst
Outdated
| It's crucial to note that other Linux mechanisms for CPU power management can | ||
| interfere with optimization objectives of GEOPM agents. When deploying an agent | ||
| that controls CPU frequency or power limits, it's recommended that the generic | ||
| scaling govermernor ``userspace`` is selected. |
There was a problem hiding this comment.
I think it's important to still mention intel_pstate here. It may interfere with your results depending on what you're trying to do. We should maybe mention userspace alongside performance.
There was a problem hiding this comment.
performance should be mentioned for when userspace is not available.
consider moving HPC tuning tips to a separate page.
| different mechanisms for affinitizing OpenMP threads within CPUs available | ||
| to each MPI process. The GEOPM control thread can also be launched as an | ||
| application thread or process that can either be part of the primary MPI | ||
| application or a completely different MPI application. Due to these factors, |
There was a problem hiding this comment.
All of these features still exist in the Controller and geopmlaunch...
why remove this now?
There was a problem hiding this comment.
Some of these details should be moved to the non-existent HPC tuning guide and/or references to geopmlaunch should be added.
cmcantalupo
force-pushed
the
release-3.0-docs
branch
from
25ca976
to
194fa5a
Compare
cmcantalupo
force-pushed
the
release-3.0-docs
branch
from
ff92ef1
to
4794e9e
Compare
Signed-off-by: Christopher M. Cantalupo <christopher.m.cantalupo@intel.com>
Signed-off-by: Christopher M. Cantalupo <christopher.m.cantalupo@intel.com>
Signed-off-by: Christopher M. Cantalupo <christopher.m.cantalupo@intel.com>
…d guide Signed-off-by: Christopher M. Cantalupo <christopher.m.cantalupo@intel.com>
Signed-off-by: Christopher M. Cantalupo <christopher.m.cantalupo@intel.com>
…on and geopmaccess Signed-off-by: Christopher M. Cantalupo <christopher.m.cantalupo@intel.com>
Signed-off-by: Christopher M. Cantalupo <christopher.m.cantalupo@intel.com>
Signed-off-by: Christopher M. Cantalupo <christopher.m.cantalupo@intel.com>
Signed-off-by: Christopher M. Cantalupo <christopher.m.cantalupo@intel.com>
cmcantalupo
force-pushed
the
release-3.0-docs
branch
from
c959509
to
3b43536
Compare
- Fails with IndexError otherwise. - Introduced in geopm#3411. Signed-off-by: Brad Geltz <brad.geltz@intel.com>
- Fails with IndexError otherwise. - Introduced in #3411. Signed-off-by: Brad Geltz <brad.geltz@intel.com>
