Update armer.rst#11
Conversation
|
Please rename your branch following the format "name"/"task" (see branch from others for examples) |
|
shaoqx
left a comment
shaoqx
left a comment
There was a problem hiding this comment.
Good job reformatting the page! Please address the comments and adapt the new outline.
| * you can set the self value during config_job to make each job different | ||
|
|
||
|
|
||
| Example Code |
There was a problem hiding this comment.
Use examples from https://enzyhtp-doc.readthedocs.io/en/latest/sci_api_tutorial/single_point.html
But here we focus on the cluster_job_config
| For most users, only the `Job configuration` requires specific input from different users. | ||
| The first step involves configuring a job using the config_job method. This method prepares the submission script by specifying the commands to be executed, environmental settings, and resource requirements. |
There was a problem hiding this comment.
Change this Bold and change it to say
none of the function will be directly access by user in normal EnzyHTP workflows. They are used by developers in APIs of EnzyHTP. However, all of the APIs that uses ARMer will expose an input that allow users to config the resource ...(elaborate)...
There was a problem hiding this comment.
And in the next section, you can smoothly introduce the cluster_job_config dict
| For most users, only the `Job configuration` requires specific input from different users. | ||
| The first step involves configuring a job using the config_job method. This method prepares the submission script by specifying the commands to be executed, environmental settings, and resource requirements. | ||
|
|
||
| .. admonition:: Here is the `cluster_job_config` dictionary |
There was a problem hiding this comment.
Make this a seperate section in parallel with the 3 main functions
There was a problem hiding this comment.
Let's introduce in full the format of the dictionary and the meaning of each keys
There was a problem hiding this comment.
We are missing the "cluster" key here in parallel with the "res_keywords" key
shaoqx
left a comment
shaoqx
left a comment
There was a problem hiding this comment.
Good job addressing the comment!
There are stilll some organization issue to address. Please read carefully the outline I sent and address the comments
Thanks!
| These parameters are specified under the argument ``res_keywords``. | ||
|
|
||
| ``core_type``: This specifies that the job should be run on GPU/CPU cores. | ||
|
|
||
| ``nodes``: How many nodes needed to request for the job. | ||
|
|
||
| ``node_cores``: How many cores needed for each node. If GPU is used, usually only one core per node will be requested. | ||
|
|
||
| ``job_name``: This sets the name of the job to "job_name". You can change this to a more descriptive name for your job. | ||
|
|
||
| ``partition``: This specifies that the job should be submitted to a specific partition, which is likely a partition dedicated to GPU resources. | ||
|
|
||
| ``mem_per_core``: This requests a number of gigabytes of memory per core. | ||
|
|
||
| ``walltime``: This sets the maximum walltime (execution time) for the job. '24:00:00' means 24 hours. | ||
|
|
There was a problem hiding this comment.
rearrange this section to align with the hierarchy of the actual dictionary.
There was a problem hiding this comment.
also be aware of the confusion Yinjie made. emphasize these keywords are build-in keywords in EnzyHTP. it is not the same as the keywords of SLURM or other job scheduling system
There was a problem hiding this comment.
By the "hierarchy of the actual dictionary" I mean like this:
There are 2 key-value pairs accepted in this dictionary, ``cluster`` and ``res_keywords``.
``cluster``
The value under this key defines ... as a ClusterInterface() object
Example: ...
``res_keywords``
The value under this key defines ... as a dictionary
<more to say about what k-v pairs of this dictionary>
Example: ...
There was a problem hiding this comment.
Also we need to explain the "default" behavior of the dictionary under res_keywords when a key is not specified.
shaoqx
left a comment
shaoqx
left a comment
There was a problem hiding this comment.
Good job addressing all the comments! Please see these new ones!
|
|
||
| * you can set the self value during config_job to make each job different | ||
|
|
||
| **Specifically, only the ``Job configuration`` requires specific input from different users.** |
There was a problem hiding this comment.
We need exactly the same name "cluster_job_config" so that user can link it to the the next section
|
|
||
| **These keywords are build-in keywords in EnzyHTP, which are not the same as the keywords of SLURM or other job scheduling system.** | ||
|
|
||
| ``res_keywords``： |
There was a problem hiding this comment.
Change this ":" to a English ":" lol
|
|
||
|
|
||
|
|
||
| .. admonition:: Here is the `cluster_job_config` dictionary |
There was a problem hiding this comment.
See an unresolved comment above
shaoqx
left a comment
shaoqx
left a comment
There was a problem hiding this comment.
Good job! We can now focus on the core component about the cluster_job_config
2 participants
No description provided.