Skip to content
Snippets Groups Projects
Commit fe2424b7 authored by Daniel CARRON's avatar Daniel CARRON :b:
Browse files

[doc] Various docstring improvements

parent ec656ca4
No related branches found
No related tags found
1 merge request!15Update documentation
Showing
with 21 additions and 21 deletions
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery and Shenzhen datasets (cross """Aggregated DataModule composed of Montgomery and Shenzhen datasets (cross
validation fold 1). validation fold 1).
See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery and Shenzhen datasets (cross """Aggregated DataModule composed of Montgomery and Shenzhen datasets (cross
validation fold 2). validation fold 2).
See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery and Shenzhen datasets (cross """Aggregated DataModule composed of Montgomery and Shenzhen datasets (cross
validation fold 3). validation fold 3).
See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery and Shenzhen datasets (cross """Aggregated DataModule composed of Montgomery and Shenzhen datasets (cross
validation fold 4). validation fold 4).
See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery and Shenzhen datasets (cross """Aggregated DataModule composed of Montgomery and Shenzhen datasets (cross
validation fold 5). validation fold 5).
See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery and Shenzhen datasets (cross """Aggregated DataModule composed of Montgomery and Shenzhen datasets (cross
validation fold 6). validation fold 6).
See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery and Shenzhen datasets (cross """Aggregated DataModule composed of Montgomery and Shenzhen datasets (cross
validation fold 7). validation fold 7).
See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery and Shenzhen datasets (cross """Aggregated DataModule composed of Montgomery and Shenzhen datasets (cross
validation fold 8). validation fold 8).
See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery and Shenzhen datasets (cross """Aggregated DataModule composed of Montgomery and Shenzhen datasets (cross
validation fold 9). validation fold 9).
See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen.datamodule.DataModule` for technical details.
......
# Copyright © 2022 Idiap Research Institute <contact@idiap.ch> # Copyright © 2022 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian """Aggregated DataModule composed of Montgomery, Shenzhen and Indian
datasets.""" datasets."""
from ....data.datamodule import ConcatDataModule from ....data.datamodule import ConcatDataModule
...@@ -14,7 +14,7 @@ from ..shenzhen.datamodule import make_split as make_shenzhen_split ...@@ -14,7 +14,7 @@ from ..shenzhen.datamodule import make_split as make_shenzhen_split
class DataModule(ConcatDataModule): class DataModule(ConcatDataModule):
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian """Aggregated DataModule composed of Montgomery, Shenzhen and Indian
datasets.""" datasets."""
def __init__(self, split_filename: str): def __init__(self, split_filename: str):
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian datasets. """Aggregated DataModule composed of Montgomery, Shenzhen and Indian datasets.
See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical
details. details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian datasets """Aggregated DataModule composed of Montgomery, Shenzhen and Indian datasets
(cross validation fold 0). (cross validation fold 0).
See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian datasets """Aggregated DataModule composed of Montgomery, Shenzhen and Indian datasets
(cross validation fold 1). (cross validation fold 1).
See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian datasets """Aggregated DataModule composed of Montgomery, Shenzhen and Indian datasets
(cross validation fold 2). (cross validation fold 2).
See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian datasets """Aggregated DataModule composed of Montgomery, Shenzhen and Indian datasets
(cross validation fold 3). (cross validation fold 3).
See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian datasets """Aggregated DataModule composed of Montgomery, Shenzhen and Indian datasets
(cross validation fold 4). (cross validation fold 4).
See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian datasets """Aggregated DataModule composed of Montgomery, Shenzhen and Indian datasets
(cross validation fold 5). (cross validation fold 5).
See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian datasets """Aggregated DataModule composed of Montgomery, Shenzhen and Indian datasets
(cross validation fold 6). (cross validation fold 6).
See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian datasets """Aggregated DataModule composed of Montgomery, Shenzhen and Indian datasets
(cross validation fold 7). (cross validation fold 7).
See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical details. See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical details.
......
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch> # SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <contact@idiap.ch>
# #
# SPDX-License-Identifier: GPL-3.0-or-later # SPDX-License-Identifier: GPL-3.0-or-later
"""Aggregated datamodule composed of Montgomery, Shenzhen and Indian datasets """Aggregated DataModule composed of Montgomery, Shenzhen and Indian datasets
(cross validation fold 8). (cross validation fold 8).
See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical See :py:class:`.montgomery_shenzhen_indian.datamodule.DataModule` for technical
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment