Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
O
oar
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
Container registry
Model registry
Operate
Environments
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
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
Jeremy Auguste
oar
Commits
f87b4618
Commit
f87b4618
authored
6 years ago
by
Jeremy Auguste
Browse files
Options
Downloads
Patches
Plain Diff
Updated look of README
parent
7388b939
No related branches found
No related tags found
No related merge requests found
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+13
-13
13 additions, 13 deletions
README.md
README.org
+14
-14
14 additions, 14 deletions
README.org
with
27 additions
and
27 deletions
README.md
+
13
−
13
View file @
f87b4618
...
@@ -17,22 +17,22 @@ Here are the requirements for each script:
...
@@ -17,22 +17,22 @@ Here are the requirements for each script:
## OARGEN
## OARGEN
The basic usage of
`oargen`
is simply
`python oargen.py -r
/
command
/
`
where
*command*
is the job
The basic usage of
`oargen`
is simply
`python oargen.py -r command`
where
*command*
is the job
to execute on the cluster.
to execute on the cluster.
Several options can be used:
Several options can be used:
-
`
--run
`
: run the job on the cluster.
-
--run: run the job on the cluster.
-
`
--time
`
*TIME*
: reservation walltime of your job. Accepted formats:
*h*
,
*h:m*
or
*h:m:s*
. Defaults to 10 hours.
-
--time
*TIME*
: reservation walltime of your job. Accepted formats:
*h*
,
*h:m*
or
*h:m:s*
. Defaults to 10 hours.
-
`
--core
`
*NB\_CORES*
: number of cores required by your job. Defaults to 1.
-
--core
*NB\_CORES*
: number of cores required by your job. Defaults to 1.
-
`
--interative
`
: launch job in interative mode instead of passive.
-
--interative: launch job in interative mode instead of passive.
-
`
--gpu
`
: request GPUs.
-
--gpu: request GPUs.
-
`
--host
`
*host1*
[
*host2*
…
*hostn*
]: name of the hosts allowed to be used on the cluster.
-
--host
*host1*
[
*host2*
...
*hostn*
]: name of the hosts allowed to be used on the cluster.
-
`
--ignore-host
`
*host1*
[
*host2*
…
*hostn*
]: name of the hosts forbidden to be used on the cluster.
-
--ignore-host
*host1*
[
*host2*
...
*hostn*
]: name of the hosts forbidden to be used on the cluster.
-
`
--anterior
`
*ANTERIOR\_ID*
: job will only be launched once the job with the specified ID is finished.
-
--anterior
*ANTERIOR\_ID*
: job will only be launched once the job with the specified ID is finished.
-
`
--checkpoint
`
*delay*
: enable the checkpoint signal with the given delay (in seconds).
-
--checkpoint
*delay*
: enable the checkpoint signal with the given delay (in seconds).
-
`
--name
`
*name*
: name of the job.
-
--name
*name*
: name of the job.
-
`
--directory
`
*directory*
: directory in which will be stored the logs of the standard output and input.
-
--directory
*directory*
: directory in which will be stored the logs of the standard output and input.
## OARSTATS
## OARSTATS
...
@@ -43,5 +43,5 @@ each user. It will also take into account the different queues.
...
@@ -43,5 +43,5 @@ each user. It will also take into account the different queues.
One option can be used:
One option can be used:
-
`
--show-hosts
`
: Adds an extra line for each user indicating which hosts are being used.
-
--show-hosts: Adds an extra line for each user indicating which hosts are being used.
This diff is collapsed.
Click to expand it.
README.org
+
14
−
14
View file @
f87b4618
#+options: toc:nil _:{} ^:{}
#+options: toc:nil _:{} ^:{}
-:nil
This repository groups a set of tools to easily use OAR.
This repository groups a set of tools to easily use OAR.
...
@@ -15,21 +15,21 @@ Here are the requirements for each script:
...
@@ -15,21 +15,21 @@ Here are the requirements for each script:
** OARGEN
** OARGEN
The basic usage of ~oargen~ is simply ~python oargen.py -r
/
command
/
~ where /command/ is the job
The basic usage of ~oargen~ is simply ~python oargen.py -r command~ where /command/ is the job
to execute on the cluster.
to execute on the cluster.
Several options can be used:
Several options can be used:
+
=
--run
=
: run the job on the cluster.
+ --run: run the job on the cluster.
+
=
--time
=
/TIME/: reservation walltime of your job. Accepted formats: /h/, /h:m/ or /h:m:s/. Defaults to 10 hours.
+ --time /TIME/: reservation walltime of your job. Accepted formats: /h/, /h:m/ or /h:m:s/. Defaults to 10 hours.
+
=
--core
=
/NB_CORES/: number of cores required by your job. Defaults to 1.
+ --core /NB_CORES/: number of cores required by your job. Defaults to 1.
+
=
--interative
=
: launch job in interative mode instead of passive.
+ --interative: launch job in interative mode instead of passive.
+
=
--gpu
=
: request GPUs.
+ --gpu: request GPUs.
+
=
--host
=
/host1/ [ /host2/ ... /hostn/ ]: name of the hosts allowed to be used on the cluster.
+ --host /host1/ [ /host2/ ... /hostn/ ]: name of the hosts allowed to be used on the cluster.
+
=
--ignore-host
=
/host1/ [ /host2/ ... /hostn/ ]: name of the hosts forbidden to be used on the cluster.
+ --ignore-host /host1/ [ /host2/ ... /hostn/ ]: name of the hosts forbidden to be used on the cluster.
+
=
--anterior
=
/ANTERIOR_ID/: job will only be launched once the job with the specified ID is finished.
+ --anterior /ANTERIOR_ID/: job will only be launched once the job with the specified ID is finished.
+
=
--checkpoint
=
/delay/: enable the checkpoint signal with the given delay (in seconds).
+ --checkpoint /delay/: enable the checkpoint signal with the given delay (in seconds).
+
=
--name
=
/name/: name of the job.
+ --name /name/: name of the job.
+
=
--directory
=
/directory/: directory in which will be stored the logs of the standard output and input.
+ --directory /directory/: directory in which will be stored the logs of the standard output and input.
** OARSTATS
** OARSTATS
...
@@ -38,4 +38,4 @@ It will print some information about the number of jobs, cores and gpus used by
...
@@ -38,4 +38,4 @@ It will print some information about the number of jobs, cores and gpus used by
each user. It will also take into account the different queues.
each user. It will also take into account the different queues.
One option can be used:
One option can be used:
+
=
--show-hosts
=
: Adds an extra line for each user indicating which hosts are being used.
+ --show-hosts: Adds an extra line for each user indicating which hosts are being used.
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