utils.rst

Tools and Utilities

.. toctree::
   :titlesonly:

• Tools
  • Frozen Class
  • Time Manager
  • Typing
• Meters
  • Meter
  • AP Meter
  • AUC Meter
  • Average Value Meter
  • Class Error Meter
  • Confusion Meter
  • Map Meter
  • Moving Average Value Meter
  • MSE Meter
  • Precision-Recall-F1 Meter
• Utils
  • Checkpoint
  • Components
  • Config
  • Distributed
  • Hash
  • Initialization
  • Misc
  • Numpy
  • Parser
  • Scripts
  • Seed
  • Sys
  • Torch
• Metrics
  • Accuracy
  • AUC
  • CMC score
  • Dice
  • F1 score
  • Focal
  • IoU
  • Precision
  • Functional
  • MRR

Tools

.. automodule:: catalyst.tools
    :members:
    :show-inheritance:

Frozen Class

.. automodule:: catalyst.tools.frozen_class
    :members:
    :undoc-members:
    :show-inheritance:

Time Manager

.. automodule:: catalyst.tools.time_manager
    :members:
    :undoc-members:
    :show-inheritance:

Typing

.. automodule:: catalyst.tools.typing
    :members:
    :undoc-members:
    :show-inheritance:

Meters

The meters from torchnet.meters.

Every meter implements :py:class:`catalyst.tools.meters.meter.Meter` interface.

Meter

.. automodule:: catalyst.tools.meters.meter
    :members:
    :undoc-members:
    :show-inheritance:

AP Meter

.. automodule:: catalyst.tools.meters.apmeter
    :members:
    :undoc-members:
    :show-inheritance:

AUC Meter

.. automodule:: catalyst.tools.meters.aucmeter
    :members:
    :undoc-members:
    :show-inheritance:

Average Value Meter

.. automodule:: catalyst.tools.meters.averagevaluemeter
    :members:
    :undoc-members:
    :show-inheritance:

Class Error Meter

.. automodule:: catalyst.tools.meters.classerrormeter
    :members:
    :undoc-members:
    :show-inheritance:

Confusion Meter

.. automodule:: catalyst.tools.meters.confusionmeter
    :members:
    :undoc-members:
    :show-inheritance:

Map Meter

.. automodule:: catalyst.tools.meters.mapmeter
    :members:
    :undoc-members:
    :show-inheritance:

Moving Average Value Meter

.. automodule:: catalyst.tools.meters.movingaveragevaluemeter
    :members:
    :undoc-members:
    :show-inheritance:

MSE Meter

.. automodule:: catalyst.tools.meters.msemeter
    :members:
    :undoc-members:
    :show-inheritance:

Precision-Recall-F1 Meter

.. automodule:: catalyst.tools.meters.ppv_tpr_f1_meter
    :members:
    :undoc-members:
    :show-inheritance:

Utils

.. automodule:: catalyst.utils
    :members:
    :show-inheritance:

Checkpoint

.. automodule:: catalyst.utils.checkpoint
    :members:
    :undoc-members:
    :show-inheritance:

Components

.. automodule:: catalyst.utils.components
    :members:
    :undoc-members:
    :show-inheritance:

Config

.. automodule:: catalyst.utils.config
    :members:
    :undoc-members:
    :show-inheritance:

Distributed

.. automodule:: catalyst.utils.distributed
    :members:
    :undoc-members:
    :show-inheritance:

Hash

.. automodule:: catalyst.utils.hash
    :members:
    :undoc-members:
    :show-inheritance:

Initialization

.. automodule:: catalyst.utils.initialization
    :members:
    :undoc-members:
    :show-inheritance:

Misc

.. automodule:: catalyst.utils.misc
    :members:
    :undoc-members:
    :show-inheritance:

Numpy

.. automodule:: catalyst.utils.numpy
    :members:
    :undoc-members:
    :show-inheritance:

Parser

.. automodule:: catalyst.utils.parser
    :members:
    :undoc-members:
    :show-inheritance:

Scripts

.. automodule:: catalyst.utils.scripts
    :members:
    :undoc-members:
    :show-inheritance:

Seed

.. automodule:: catalyst.utils.seed
    :members:
    :undoc-members:
    :show-inheritance:

Sys

.. automodule:: catalyst.utils.sys
    :members:
    :undoc-members:
    :show-inheritance:

Torch

.. automodule:: catalyst.utils.torch
    :members:
    :undoc-members:
    :show-inheritance:

Metrics

Accuracy

.. automodule:: catalyst.utils.metrics.accuracy
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: catalyst.utils.metrics.multi_label_accuracy
    :members:
    :undoc-members:
    :show-inheritance:

AUC

.. automodule:: catalyst.utils.metrics.auc
    :members:
    :undoc-members:
    :show-inheritance:

CMC score

.. automodule:: catalyst.utils.metrics.cmc_score_count
    :members:
    :undoc-members:
    :show-inheritance:

.. automodule:: catalyst.utils.metrics.cmc_score
    :members:
    :undoc-members:
    :show-inheritance:

Dice

.. automodule:: catalyst.utils.metrics.dice
    :members:
    :undoc-members:
    :show-inheritance:

F1 score

.. automodule:: catalyst.utils.metrics.f1_score
    :members:
    :undoc-members:
    :show-inheritance:

Focal

.. automodule:: catalyst.utils.metrics.focal
    :members:
    :undoc-members:
    :show-inheritance:

IoU

.. automodule:: catalyst.utils.metrics.iou
    :members:
    :undoc-members:
    :show-inheritance:

Precision

.. automodule:: catalyst.utils.metrics.average_precision
    :members:
    :undoc-members:
    :show-inheritance:

Functional

.. automodule:: catalyst.utils.metrics.functional
    :members:
    :undoc-members:
    :show-inheritance:

MRR

.. automodule:: catalyst.utils.metrics.mrr
    :members:
    :undoc-members:
    :show-inheritance: