Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanluoyc committed May 8, 2024
1 parent c0ef120 commit 0508f0c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 10 deletions.
1 change: 1 addition & 0 deletions lxm3/xm_cluster/executable_specs.py
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,7 @@ class SingularityContainer(job_blocks.ExecutableSpec):
The image will be converted and cached as a singularity SIF image.
3. Any other URIs supported by Singularity/Apptainer.
e.g., docker://python:3.10.
The image URI will be passed to singularity as is.
"""

Expand Down
13 changes: 3 additions & 10 deletions lxm3/xm_cluster/executors.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ class SingularityOptions:
extra_options: Extra commandline options to pass to singularity.
When using the ``extra_options``, be aware of the following:
1. lxm3 currently probably won't likely work with
``--contain``, ``--pwd`` and ``-wd``,
1. You should not set a working directory as LXM3 configures those
for the executable.
2. You don't have to pass ``--nv`` for GPU jobs,
lxm3 will do it for you.
"""
Expand All @@ -48,15 +48,8 @@ class DockerOptions:
"""Options for singularity container.
Args:
bind: Mapping of the form ``{src: dst}``.
User-bind path specification of the form ``-B <src>:<dst>``.
volumes: Bind-mounted volumes used by the docker runtime.
extra_options: Extra commandline options to pass to singularity.
When using the ``extra_options``, be aware of the following:
1. lxm3 currently probably won't likely work with
``--contain``, ``--pwd`` and ``-wd``,
2. You don't have to pass ``--nv`` for GPU jobs,
lxm3 will do it for you.
"""

volumes: Dict[str, str] = attr.Factory(dict)
Expand Down

0 comments on commit 0508f0c

Please sign in to comment.