Skip to content

Commit

Permalink
Remove Long Deprecated SmartSim Modules (#514)
Browse files Browse the repository at this point in the history
Removed deprecated SmartSim modules (slurm and mpirunSettings).

[ reviewed by @MattToast @al-rigazzi ]
[ committed by @amandarichardsonn ]
  • Loading branch information
amandarichardsonn authored Mar 14, 2024
1 parent 3c271f3 commit 6660efc
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 93 deletions.
12 changes: 9 additions & 3 deletions doc/api/smartsim_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -538,12 +538,18 @@ SmartSim includes built-in utilities for supporting PyTorch in training and infe
Slurm
=====

.. currentmodule:: smartsim.slurm
.. currentmodule:: smartsim.wlm.slurm

.. autosummary::

get_allocation
release_allocation

.. automodule:: smartsim.slurm
validate
get_default_partition
get_hosts
get_queue
get_tasks
get_tasks_per_node

.. automodule:: smartsim.wlm.slurm
:members:
4 changes: 4 additions & 0 deletions doc/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,16 @@ To be released at some future point in time

Description

- Remove deprecated SmartSim modules
- SmartSim Documentation refactor
- Update the version of Redis from `7.0.4` to `7.2.4`
- Update Experiment API typing
- Fix publishing of development docs

Detailed Notes

- Removed deprecated SmartSim modules: slurm and mpirunSettings.
(SmartSim-PR514_)
- Implemented new structure of SmartSim documentation. Added examples
images and further detail of SmartSim components.
- Update Redis version to `7.2.4`. This change fixes an issue in the Redis
Expand All @@ -36,6 +39,7 @@ Detailed Notes
(SmartSim-PR-PR504_)
- Update the generic `t.Any` typehints in Experiment API. (SmartSim-PR501_)

.. _SmartSim-PR514: https://github.com/CrayLabs/SmartSim/pull/514
.. _SmartSim-PR463: https://github.com/CrayLabs/SmartSim/pull/463
.. _SmartSim-PR507: https://github.com/CrayLabs/SmartSim/pull/507
.. _SmartSim-PR504: https://github.com/CrayLabs/SmartSim/pull/504
Expand Down
41 changes: 0 additions & 41 deletions smartsim/settings/mpirunSettings.py

This file was deleted.

45 changes: 0 additions & 45 deletions smartsim/slurm.py

This file was deleted.

4 changes: 2 additions & 2 deletions smartsim/wlm/slurm.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,12 @@ def get_allocation(
The options can be used to pass extra settings to the
workload manager such as the following for Slurm:
- nodelist="nid00004"
- nodelist="nid00004"
For arguments without a value, pass None or and empty
string as the value. For Slurm:
- exclusive=None
- exclusive=None
:param nodes: number of nodes for the allocation, defaults to 1
:type nodes: int, optional
Expand Down
2 changes: 1 addition & 1 deletion tests/test_slurm_get_alloc.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

import pytest

from smartsim.slurm import _get_alloc_cmd
from smartsim.wlm.slurm import _get_alloc_cmd

# The tests in this file belong to the group_b group
pytestmark = pytest.mark.group_b
Expand Down
6 changes: 5 additions & 1 deletion tests/test_slurm_validation.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,11 @@
import pytest

from smartsim.error.errors import LauncherError
from smartsim.slurm import _get_system_partition_info, get_default_partition, validate
from smartsim.wlm.slurm import (
_get_system_partition_info,
get_default_partition,
validate,
)

# The tests in this file belong to the group_b group
pytestmark = pytest.mark.group_b
Expand Down

0 comments on commit 6660efc

Please sign in to comment.