PyPI - mapreader - Versions diffs - 1.3.4__tar.gz → 1.3.5__tar.gz - Mend

mapreader 1.3.4tar.gz → 1.3.5tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (50) hide show

{mapreader-1.3.4 → mapreader-1.3.5}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mapreader
-Version: 1.3.4
+Version: 1.3.5
 Summary: A computer vision pipeline for the semantic exploration of maps/images at scale
 Home-page: https://github.com/Living-with-machines/MapReader
 Download-URL: https://github.com/Living-with-machines/MapReader/archive/refs/heads/main.zip
@@ -66,44 +66,46 @@ Requires-Dist: transformers<5.0.0; extra == "dev"
 Requires-Dist: black<25.0.0,>=23.7.0; extra == "dev"
 Requires-Dist: flake8<8.0.0,>=6.0.0; extra == "dev"
-<div align="center">
-    <br>
-    <p align="center">
-    <h1>MapReader</h1>
-    <h2>A computer vision pipeline for exploring and analyzing images at scale</h2>
-    </p>
-</div>
-<p align="center">
-    <a href="https://pypi.org/project/mapreader/">
-        <img alt="PyPI" src="https://img.shields.io/pypi/v/MapReader">
-    </a>
-    <a href="https://github.com/Living-with-machines/MapReader/blob/main/LICENSE">
-        <img alt="License" src="https://img.shields.io/badge/License-MIT-yellow.svg">
-    </a>
-    <a href="https://github.com/Living-with-machines/MapReader/actions/workflows/mr_ci.yml/badge.svg">
-        <img alt="Integration Tests badge" src="https://github.com/Living-with-machines/MapReader/actions/workflows/mr_ci.yml/badge.svg">
-    </a>
-    <a href="https://zenodo.org/badge/latestdoi/430661738"><img src="https://zenodo.org/badge/430661738.svg" alt="DOI"></a>
-    <br/>
-    <a href="https://codecov.io/github/Living-with-machines/MapReader" >
-    <img src="https://codecov.io/github/Living-with-machines/MapReader/graph/badge.svg?token=38GQ3O1GB5"/>
-    </a>
-</p>
+# MapReader
+> [!IMPORTANT] A computer vision pipeline for exploring and analyzing images at scale
-## What is MapReader?
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
-<div align="center">
-    <figure>
-    <img src="https://raw.githubusercontent.com/Living-with-machines/MapReader/main/figs/river_banner_8bit.png"
-        alt="Annotated Map with Prediction Outputs"
-        width="70%">
-    </figure>
-</div>
+![PyPI](https://img.shields.io/pypi/v/MapReader)
+![License](https://img.shields.io/badge/License-MIT-yellow.svg)
+![Integration Tests badge](https://github.com/Living-with-machines/MapReader/actions/workflows/mr_ci.yml/badge.svg)
+![DOI](https://zenodo.org/badge/430661738.svg)
+![CodeCov](https://codecov.io/github/Living-with-machines/MapReader/graph/badge.svg?token=38GQ3O1GB5)
+## Table of Contents
+- [MapReader](#mapreader)
+  - [Table of Contents](#table-of-contents)
+  - [What is MapReader?](#what-is-mapreader)
+  - [Overview](#overview)
+    - [MapReader pipeline](#mapreader-pipeline)
+  - [Documentation](#documentation)
+  - [What is included in this repo?](#what-is-included-in-this-repo)
+  - [How to cite MapReader](#how-to-cite-mapreader)
+  - [Acknowledgements](#acknowledgements)
+  - [Contributors](#contributors)
+---
+<!--- sphinx-include --->
+## What is MapReader?
 MapReader is an end-to-end computer vision (CV) pipeline for exploring and analyzing images at scale.
+<figure align="center">
+  <img src="https://raw.githubusercontent.com/Living-with-machines/MapReader/main/docs/source/_static/river_banner_8bit.png"
+      alt="Annotated Map with Prediction Outputs"
+      width="70%">
+</figure>
 MapReader was developed in the [Living with Machines](https://livingwithmachines.ac.uk/) project to analyze large collections of historical maps but is a _**generalizable**_ computer vision pipeline which can be applied to _**any images**_ in a wide variety of domains.
 ## Overview
@@ -112,30 +114,28 @@ MapReader is a groundbreaking interdisciplinary tool that emerged from a specifi
 ### MapReader pipeline
-<div align="center">
-  <figure>
-  <img src="https://raw.githubusercontent.com/Living-with-machines/MapReader/main/docs/source/figures/pipeline_explained.png"
+The MapReader pipeline consists of a linear sequence of tasks which, together, can be used to train a computer vision (CV) classifier to recognize visual features within maps and identify patches containing these features across entire map collections:
+<figure align="center">
+  <img src="https://raw.githubusercontent.com/Living-with-machines/MapReader/main/docs/source/_static/pipeline_explained.png"
         alt="MapReader pipeline"
         width="70%">
-  </figure>
-</div>
-The MapReader pipeline consists of a linear sequence of tasks which, together, can be used to train a computer vision (CV) classifier to recognize visual features within maps and identify patches containing these features across entire map collections.
+</figure>
-See our [About MapReader](https://mapreader.readthedocs.io/en/latest/About.html) page to learn more.
+See our [Introduction to MapReader](https://mapreader.readthedocs.io/en/latest/introduction-to-mapreader/) page to learn more.
 ## Documentation
-The MapReader documentation can be found at https://mapreader.readthedocs.io/en/latest/index.html.
+The MapReader documentation can be found at https://mapreader.readthedocs.io/en/latest/.
-**New users** should refer to the [Installation instructions](https://mapreader.readthedocs.io/en/latest/Install.html) and [Input guidance](https://mapreader.readthedocs.io/en/latest/Input-guidance.html) for help with the initial set up of MapReader.
+**New users** should refer to the [Installation instructions](https://mapreader.readthedocs.io/en/latest/getting-started/installation-instructions/index.html) and [Input guidance](https://mapreader.readthedocs.io/en/latest/using-mapreader/input-guidance/) for help with the initial set up of MapReader.
-**All users** should refer to our [User Guide](https://mapreader.readthedocs.io/en/latest/User-guide/User-guide.html) for guidance on how to use MapReader. This contains end-to-end instructions on how to use the MapReader pipeline, plus a number of worked examples illustrating use cases such as:
+**All users** should refer to our [User Guide](https://mapreader.readthedocs.io/en/latest/using-mapreader/) for guidance on how to use MapReader. This contains end-to-end instructions on how to use the MapReader pipeline, plus a number of worked examples illustrating use cases such as:
 - Geospatial images (i.e. maps)
 - Non-geospatial images
- **Developers and contributors** may also want to refer to the [API documentation](https://mapreader.readthedocs.io/en/latest/api/index.html) and [Contribution guide](https://mapreader.readthedocs.io/en/latest/Contribution-guide/Contribution-guide.html) for guidance on how to contribute to the MapReader package.
+ **Developers and contributors** may also want to refer to the [API documentation](https://mapreader.readthedocs.io/en/latest/in-depth-resources/api/mapreader/) and [Contribution guide](https://mapreader.readthedocs.io/en/latest/community-and-contributions/contribution-guide/) for guidance on how to contribute to the MapReader package.
 **Join our Slack workspace!**
 Please fill out [this form](https://forms.gle/dXjECHZQkwrZ3Xpt9) to receive an invitation to the Slack workspace.
@@ -163,7 +163,6 @@ If you use MapReader in your work, please cite both the MapReader repo and [our
 - Kasra Hosseini, Daniel C. S. Wilson, Kaspar Beelen, and Katherine McDonough. 2022. MapReader: a computer vision pipeline for the semantic exploration of maps at scale. In Proceedings of the 6th ACM SIGSPATIAL International Workshop on Geospatial Humanities (GeoHumanities '22). Association for Computing Machinery, New York, NY, USA, 8–19. https://doi.org/10.1145/3557919.3565812
 - Kasra Hosseini, Rosie Wood, Andy Smith, Katie McDonough, Daniel C.S. Wilson, Christina Last, Kalle Westerling, and Evangeline Mae Corcoran. “Living-with-machines/mapreader: End of Lwm”. Zenodo, July 27, 2023. https://doi.org/10.5281/zenodo.8189653.
 ## Acknowledgements
 This work was supported by Living with Machines (AHRC grant AH/S01179X/1) and The Alan Turing Institute (EPSRC grant EP/N510129/1).
@@ -174,10 +173,6 @@ Maps above reproduced with the permission of the National Library of Scotland ht
 ## Contributors
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

{mapreader-1.3.4 → mapreader-1.3.5}/README.md RENAMED Viewed

@@ -1,41 +1,43 @@
-<div align="center">
-    <br>
-    <p align="center">
-    <h1>MapReader</h1>
-    <h2>A computer vision pipeline for exploring and analyzing images at scale</h2>
-    </p>
-</div>
-<p align="center">
-    <a href="https://pypi.org/project/mapreader/">
-        <img alt="PyPI" src="https://img.shields.io/pypi/v/MapReader">
-    </a>
-    <a href="https://github.com/Living-with-machines/MapReader/blob/main/LICENSE">
-        <img alt="License" src="https://img.shields.io/badge/License-MIT-yellow.svg">
-    </a>
-    <a href="https://github.com/Living-with-machines/MapReader/actions/workflows/mr_ci.yml/badge.svg">
-        <img alt="Integration Tests badge" src="https://github.com/Living-with-machines/MapReader/actions/workflows/mr_ci.yml/badge.svg">
-    </a>
-    <a href="https://zenodo.org/badge/latestdoi/430661738"><img src="https://zenodo.org/badge/430661738.svg" alt="DOI"></a>
-    <br/>
-    <a href="https://codecov.io/github/Living-with-machines/MapReader" >
-    <img src="https://codecov.io/github/Living-with-machines/MapReader/graph/badge.svg?token=38GQ3O1GB5"/>
-    </a>
-</p>
+# MapReader
+> [!IMPORTANT] A computer vision pipeline for exploring and analyzing images at scale
-## What is MapReader?
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
-<div align="center">
-    <figure>
-    <img src="https://raw.githubusercontent.com/Living-with-machines/MapReader/main/figs/river_banner_8bit.png"
-        alt="Annotated Map with Prediction Outputs"
-        width="70%">
-    </figure>
-</div>
+![PyPI](https://img.shields.io/pypi/v/MapReader)
+![License](https://img.shields.io/badge/License-MIT-yellow.svg)
+![Integration Tests badge](https://github.com/Living-with-machines/MapReader/actions/workflows/mr_ci.yml/badge.svg)
+![DOI](https://zenodo.org/badge/430661738.svg)
+![CodeCov](https://codecov.io/github/Living-with-machines/MapReader/graph/badge.svg?token=38GQ3O1GB5)
+## Table of Contents
+- [MapReader](#mapreader)
+  - [Table of Contents](#table-of-contents)
+  - [What is MapReader?](#what-is-mapreader)
+  - [Overview](#overview)
+    - [MapReader pipeline](#mapreader-pipeline)
+  - [Documentation](#documentation)
+  - [What is included in this repo?](#what-is-included-in-this-repo)
+  - [How to cite MapReader](#how-to-cite-mapreader)
+  - [Acknowledgements](#acknowledgements)
+  - [Contributors](#contributors)
+---
+<!--- sphinx-include --->
+## What is MapReader?
 MapReader is an end-to-end computer vision (CV) pipeline for exploring and analyzing images at scale.
+<figure align="center">
+  <img src="https://raw.githubusercontent.com/Living-with-machines/MapReader/main/docs/source/_static/river_banner_8bit.png"
+      alt="Annotated Map with Prediction Outputs"
+      width="70%">
+</figure>
 MapReader was developed in the [Living with Machines](https://livingwithmachines.ac.uk/) project to analyze large collections of historical maps but is a _**generalizable**_ computer vision pipeline which can be applied to _**any images**_ in a wide variety of domains.
 ## Overview
@@ -44,30 +46,28 @@ MapReader is a groundbreaking interdisciplinary tool that emerged from a specifi
 ### MapReader pipeline
-<div align="center">
-  <figure>
-  <img src="https://raw.githubusercontent.com/Living-with-machines/MapReader/main/docs/source/figures/pipeline_explained.png"
+The MapReader pipeline consists of a linear sequence of tasks which, together, can be used to train a computer vision (CV) classifier to recognize visual features within maps and identify patches containing these features across entire map collections:
+<figure align="center">
+  <img src="https://raw.githubusercontent.com/Living-with-machines/MapReader/main/docs/source/_static/pipeline_explained.png"
         alt="MapReader pipeline"
         width="70%">
-  </figure>
-</div>
-The MapReader pipeline consists of a linear sequence of tasks which, together, can be used to train a computer vision (CV) classifier to recognize visual features within maps and identify patches containing these features across entire map collections.
+</figure>
-See our [About MapReader](https://mapreader.readthedocs.io/en/latest/About.html) page to learn more.
+See our [Introduction to MapReader](https://mapreader.readthedocs.io/en/latest/introduction-to-mapreader/) page to learn more.
 ## Documentation
-The MapReader documentation can be found at https://mapreader.readthedocs.io/en/latest/index.html.
+The MapReader documentation can be found at https://mapreader.readthedocs.io/en/latest/.
-**New users** should refer to the [Installation instructions](https://mapreader.readthedocs.io/en/latest/Install.html) and [Input guidance](https://mapreader.readthedocs.io/en/latest/Input-guidance.html) for help with the initial set up of MapReader.
+**New users** should refer to the [Installation instructions](https://mapreader.readthedocs.io/en/latest/getting-started/installation-instructions/index.html) and [Input guidance](https://mapreader.readthedocs.io/en/latest/using-mapreader/input-guidance/) for help with the initial set up of MapReader.
-**All users** should refer to our [User Guide](https://mapreader.readthedocs.io/en/latest/User-guide/User-guide.html) for guidance on how to use MapReader. This contains end-to-end instructions on how to use the MapReader pipeline, plus a number of worked examples illustrating use cases such as:
+**All users** should refer to our [User Guide](https://mapreader.readthedocs.io/en/latest/using-mapreader/) for guidance on how to use MapReader. This contains end-to-end instructions on how to use the MapReader pipeline, plus a number of worked examples illustrating use cases such as:
 - Geospatial images (i.e. maps)
 - Non-geospatial images
- **Developers and contributors** may also want to refer to the [API documentation](https://mapreader.readthedocs.io/en/latest/api/index.html) and [Contribution guide](https://mapreader.readthedocs.io/en/latest/Contribution-guide/Contribution-guide.html) for guidance on how to contribute to the MapReader package.
+ **Developers and contributors** may also want to refer to the [API documentation](https://mapreader.readthedocs.io/en/latest/in-depth-resources/api/mapreader/) and [Contribution guide](https://mapreader.readthedocs.io/en/latest/community-and-contributions/contribution-guide/) for guidance on how to contribute to the MapReader package.
 **Join our Slack workspace!**
 Please fill out [this form](https://forms.gle/dXjECHZQkwrZ3Xpt9) to receive an invitation to the Slack workspace.
@@ -95,7 +95,6 @@ If you use MapReader in your work, please cite both the MapReader repo and [our
 - Kasra Hosseini, Daniel C. S. Wilson, Kaspar Beelen, and Katherine McDonough. 2022. MapReader: a computer vision pipeline for the semantic exploration of maps at scale. In Proceedings of the 6th ACM SIGSPATIAL International Workshop on Geospatial Humanities (GeoHumanities '22). Association for Computing Machinery, New York, NY, USA, 8–19. https://doi.org/10.1145/3557919.3565812
 - Kasra Hosseini, Rosie Wood, Andy Smith, Katie McDonough, Daniel C.S. Wilson, Christina Last, Kalle Westerling, and Evangeline Mae Corcoran. “Living-with-machines/mapreader: End of Lwm”. Zenodo, July 27, 2023. https://doi.org/10.5281/zenodo.8189653.
 ## Acknowledgements
 This work was supported by Living with Machines (AHRC grant AH/S01179X/1) and The Alan Turing Institute (EPSRC grant EP/N510129/1).
@@ -106,10 +105,6 @@ Maps above reproduced with the permission of the National Library of Scotland ht
 ## Contributors
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

{mapreader-1.3.4 → mapreader-1.3.5}/mapreader/__init__.py RENAMED Viewed

@@ -34,5 +34,7 @@ from mapreader.load import geo_utils
 import mapreader
 def print_version():
+    """Print the current version of mapreader."""
     print(mapreader.__version__)

{mapreader-1.3.4 → mapreader-1.3.5}/mapreader/_version.py RENAMED Viewed

@@ -8,11 +8,11 @@ import json
 version_json = '''
 {
- "date": "2024-07-05T11:21:59+0100",
+ "date": "2024-08-02T15:22:56+0100",
  "dirty": false,
  "error": null,
- "full-revisionid": "add823a499b1d0763327f9d56962c2a6af0e2d42",
- "version": "1.3.4"
+ "full-revisionid": "49ac0f1daccf0da74b0570db6ade09578debb164",
+ "version": "1.3.5"
 }
 '''  # END VERSION_JSON

{mapreader-1.3.4 → mapreader-1.3.5}/mapreader/annotate/annotator.py RENAMED Viewed

@@ -680,7 +680,8 @@ class Annotator:
         Notes
         -----
-        This method is a wrapper for the ``_annotate`` method.
+        This method is a wrapper for the
+        :meth:`~.annotate.annotator.Annotate._annotate` method.
         """
         if sortby is not None:
             self._sortby = sortby

{mapreader-1.3.4 → mapreader-1.3.5}/mapreader/classify/classifier.py RENAMED Viewed

@@ -31,6 +31,77 @@ from .datasets import PatchDataset
 class ClassifierContainer:
+    """
+    A class to store and train a PyTorch model.
+    Parameters
+    ----------
+    model : str, nn.Module or None
+        The PyTorch model to add to the object.
+        - If passed as a string, will run ``_initialize_model(model, **kwargs)``. See https://pytorch.org/vision/0.8/models.html for options.
+        - Must be ``None`` if ``load_path`` is specified as model will be loaded from file.
+    labels_map: Dict or None
+        A dictionary containing the mapping of each label index to its label, with indices as keys and labels as values (i.e. idx: label).
+        Can only be ``None`` if ``load_path`` is specified as labels_map will be loaded from file.
+    dataloaders: Dict or None
+        A dictionary containing set names as keys and dataloaders as values (i.e. set_name: dataloader).
+    device : str, optional
+        The device to be used for training and storing models.
+        Can be set to "default", "cpu", "cuda:0", etc. By default, "default".
+    input_size : int, optional
+        The expected input size of the model. Default is ``(224,224)``.
+    is_inception : bool, optional
+        Whether the model is an Inception-style model.
+        Default is ``False``.
+    load_path : str, optional
+        The path to an ``.obj`` file containing a
+    force_device : bool, optional
+        Whether to force the use of a specific device.
+        If set to ``True``, the default device is used.
+        Defaults to ``False``.
+    kwargs : Dict
+        Keyword arguments to pass to the
+        :meth:`~.classify.classifier.ClassifierContainer._initialize_model`
+        method (if passing ``model`` as a string).
+    Attributes
+    ----------
+    device : torch.device
+        The device being used for training and storing models.
+    dataloaders : dict
+        A dictionary to store dataloaders for the model.
+    labels_map : dict
+        A dictionary mapping label indices to their labels.
+    dataset_sizes : dict
+        A dictionary to store sizes of datasets for the model.
+    model : torch.nn.Module
+        The model.
+    input_size : None or tuple of int
+        The size of the input to the model.
+    is_inception : bool
+        A flag indicating if the model is an Inception model.
+    optimizer : None or torch.optim.Optimizer
+        The optimizer being used for training the model.
+    scheduler : None or torch.optim.lr_scheduler._LRScheduler
+        The learning rate scheduler being used for training the model.
+    criterion : None or nn.modules.loss._Loss
+        The criterion to use for training the model.
+    metrics : dict
+        A dictionary to store the metrics computed during training.
+    last_epoch : int
+        The last epoch number completed during training.
+    best_loss : torch.Tensor
+        The best validation loss achieved during training.
+    best_epoch : int
+        The epoch in which the best validation loss was achieved during
+        training.
+    tmp_save_filename : str
+        A temporary file name to save checkpoints during training and
+        validation.
+    """
     def __init__(
         self,
         model: str | nn.Module | None,
@@ -43,75 +114,6 @@ class ClassifierContainer:
         force_device: bool | None = False,
         **kwargs,
     ):
-        """
-        Initialize an ClassifierContainer object.
-        Parameters
-        ----------
-        model : str, nn.Module or None
-            The PyTorch model to add to the object.
-            - If passed as a string, will run ``_initialize_model(model, **kwargs)``. See https://pytorch.org/vision/0.8/models.html for options.
-            - Must be ``None`` if ``load_path`` is specified as model will be loaded from file.
-        labels_map: Dict or None
-            A dictionary containing the mapping of each label index to its label, with indices as keys and labels as values (i.e. idx: label).
-            Can only be ``None`` if ``load_path`` is specified as labels_map will be loaded from file.
-        dataloaders: Dict or None
-            A dictionary containing set names as keys and dataloaders as values (i.e. set_name: dataloader).
-        device : str, optional
-            The device to be used for training and storing models.
-            Can be set to "default", "cpu", "cuda:0", etc. By default, "default".
-        input_size : int, optional
-            The expected input size of the model. Default is ``(224,224)``.
-        is_inception : bool, optional
-            Whether the model is an Inception-style model.
-            Default is ``False``.
-        load_path : str, optional
-            The path to an ``.obj`` file containing a
-        force_device : bool, optional
-            Whether to force the use of a specific device.
-            If set to ``True``, the default device is used.
-            Defaults to ``False``.
-        kwargs : Dict
-            Keyword arguments to pass to the ``_initialize_model()`` method (if passing ``model`` as a string).
-        Attributes
-        ----------
-        device : torch.device
-            The device being used for training and storing models.
-        dataloaders : dict
-            A dictionary to store dataloaders for the model.
-        labels_map : dict
-            A dictionary mapping label indices to their labels.
-        dataset_sizes : dict
-            A dictionary to store sizes of datasets for the model.
-        model : torch.nn.Module
-            The model.
-        input_size : None or tuple of int
-            The size of the input to the model.
-        is_inception : bool
-            A flag indicating if the model is an Inception model.
-        optimizer : None or torch.optim.Optimizer
-            The optimizer being used for training the model.
-        scheduler : None or torch.optim.lr_scheduler._LRScheduler
-            The learning rate scheduler being used for training the model.
-        criterion : None or nn.modules.loss._Loss
-            The criterion to use for training the model.
-        metrics : dict
-            A dictionary to store the metrics computed during training.
-        last_epoch : int
-            The last epoch number completed during training.
-        best_loss : torch.Tensor
-            The best validation loss achieved during training.
-        best_epoch : int
-            The epoch in which the best validation loss was achieved during
-            training.
-        tmp_save_filename : str
-            A temporary file name to save checkpoints during training and
-            validation.
-        """
         # set up device
         if device in ["default", None]:
             self.device = torch.device("cuda:0" if torch.cuda.is_available() else "cpu")
@@ -624,7 +626,7 @@ Use ``initialize_optimizer`` or ``add_optimizer`` to define one."  # noqa
         Notes
         -----
         This method calls the
-        :meth:`mapreader.train.classifier.classifier.train` method with the
+        :meth:`~.train.classifier.classifier.train` method with the
         ``num_epochs`` set to ``1`` and all the other parameters specified in
         the function arguments.
         """
@@ -674,7 +676,7 @@ Use ``initialize_optimizer`` or ``add_optimizer`` to define one."  # noqa
         Train the model on the specified phases for a given number of epochs.
         Wrapper function for
-        :meth:`mapreader.train.classifier.classifier.train_core` method to
+        :meth:`~.train.classifier.classifier.train_core` method to
         capture exceptions (``KeyboardInterrupt`` is the only supported
         exception currently).
@@ -716,7 +718,7 @@ Use ``initialize_optimizer`` or ``add_optimizer`` to define one."  # noqa
         Notes
         -----
         Refer to the documentation of
-        :meth:`mapreader.train.classifier.classifier.train_core` for more
+        :meth:`~.train.classifier.classifier.train_core` for more
         information.
         """
@@ -781,16 +783,19 @@ Use ``initialize_optimizer`` or ``add_optimizer`` to define one."  # noqa
         Raises
         ------
         ValueError
-            If the criterion is not set. Use the ``add_criterion`` method to
-            set the criterion.
+            If the criterion is not set. Use the
+            :meth:`~.classify.classifier.ClassifierContainer.add_criterion`
+            method to set the criterion.
             If the optimizer is not set and the phase is "train". Use the
-            ``initialize_optimizer`` or ``add_optimizer`` method to set the
-            optimizer.
+            :meth:`~.classify.classifier.ClassifierContainer.initialize_optimizer`
+            or :meth:`~.classify.classifier.ClassifierContainer.add_optimizer`
+            method to set the optimizer.
         KeyError
             If the specified phase cannot be found in the keys of the object's
-            ``dataloaders`` dictionary property.
+            :attr:`~.classify.classifier.ClassifierContainer.dataloaders`
+            dictionary property.
         Returns
         -------
@@ -1102,11 +1107,11 @@ Use ``add_criterion`` to define one."
         Notes
         -----
         This method uses both the
-        ``sklearn.metrics.precision_recall_fscore_support`` and
-        ``sklearn.metrics.roc_auc_score`` functions from ``scikit-learn`` to
-        calculate the metrics for each average type (``"micro"``, ``"macro"``
-        and ``"weighted"``). The results are then added to the ``metrics``
-        dictionary. It also writes the metrics to the TensorBoard
+        :func:`sklearn.metrics.precision_recall_fscore_support` and
+        :func:`sklearn.metrics.roc_auc_score` functions from ``scikit-learn``
+        to calculate the metrics for each average type (``"micro"``,
+        ``"macro"`` and ``"weighted"``). The results are then added to the
+        ``metrics`` dictionary. It also writes the metrics to the TensorBoard
         SummaryWriter, if ``tboard_writer`` is not None.
         """
         # convert y_score to a numpy array:
@@ -1501,9 +1506,9 @@ Use ``add_criterion`` to define one."
         Notes
         -----
         This method uses the dataloader of the ``ImageClassifierData`` class
-        and the ``torchvision.utils.make_grid`` function to display the sample
-        data in a grid format. It also calls the ``_imshow`` method of the
-        ``ImageClassifierData`` class to show the sample data.
+        and the :func:`torchvision.utils.make_grid` function to display the
+        sample data in a grid format. It also calls the ``_imshow`` method of
+        the ``ImageClassifierData`` class to show the sample data.
         """
         if set_name not in self.dataloaders.keys():
             raise ValueError(

mapreader 1.3.4__tar.gz → 1.3.5__tar.gz

mapreader 1.3.4tar.gz → 1.3.5tar.gz