segmodels-keras 0.1.0.dev0__tar.gz

segmodels_keras-0.1.0.dev0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2018, Pavel Yakubovskiy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

segmodels_keras-0.1.0.dev0/MANIFEST.in

@@ -0,0 +1 @@
+include README.md LICENSE requirements.txt

segmodels_keras-0.1.0.dev0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.4
+Name: segmodels_keras
+Version: 0.1.0.dev0
+Summary: Image segmentation models with pre-trained backbones with Keras.
+Home-page: https://github.com/theroggy/segmodels_keras
+Author: Pieter Roggemans
+Author-email: pieter.roggemans@gmail.com
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.0.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: keras
+Provides-Extra: tests
+Requires-Dist: numpy; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: scikit-image; extra == "tests"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+Image segmentation models with pre-trained backbones with Keras.

segmodels_keras-0.1.0.dev0/README.rst

@@ -0,0 +1,260 @@
+segmodels_keras
+=========================
+
+This is a fork of the
+[segmentation_models](https://github.com/qubvel/segmentation_models) library by
+Pavel Iakubovskii, which is not maintained anymore.
+
+This fork is updated to support latest versions of Keras and TensorFlow, and also
+contains some bug fixes and improvements.
+
+It is not meant as a full replacement of the original library, but rather as a
+solution for a library I developed and depended on segmentation_models:
+[orthoseg](https://github.com/orthoseg/orthoseg).
+
+Hence, backwards compatibility,... is not guaranteed or even an explicit goal.
+
+
+**The main features** of this library are:
+
+-  High level API (just two lines of code to create model for segmentation)
+-  **4** models architectures for binary and multi-class image segmentation
+   (including legendary **Unet**)
+-  **25** available backbones for each architecture
+-  All backbones have **pre-trained** weights for faster and better
+   convergence
+- Helpful segmentation losses (Jaccard, Dice, Focal) and metrics (IoU, F-score)
+
+
+Table of Contents
+~~~~~~~~~~~~~~~~~
+ - `Quick start`_
+ - `Simple training pipeline`_
+ - `Examples`_
+ - `Models and Backbones`_
+ - `Installation`_
+ - `Documentation`_
+ - `Change log`_
+ - `Citing`_
+ - `License`_
+ 
+Quick start
+~~~~~~~~~~~
+Library is build to work together with Keras and TensorFlow Keras frameworks
+
+.. code:: python
+
+    import segmentation_models as sm
+    # Segmentation Models: using `keras` framework.
+
+By default it tries to import ``keras``, if it is not installed, it will try to start with ``tensorflow.keras`` framework.
+There are several ways to choose framework:
+
+- Provide environment variable ``SM_FRAMEWORK=keras`` / ``SM_FRAMEWORK=tf.keras`` before import ``segmentation_models``
+- Change framework ``sm.set_framework('keras')`` /  ``sm.set_framework('tf.keras')``
+
+You can also specify what kind of ``image_data_format`` to use, segmentation-models works with both: ``channels_last`` and ``channels_first``.
+This can be useful for further model conversion to Nvidia TensorRT format or optimizing model for cpu/gpu computations.
+
+.. code:: python
+
+    import keras
+    # or from tensorflow import keras
+
+    keras.backend.set_image_data_format('channels_last')
+    # or keras.backend.set_image_data_format('channels_first')
+
+Created segmentation model is just an instance of Keras Model, which can be build as easy as:
+
+.. code:: python
+    
+    model = sm.Unet()
+    
+Depending on the task, you can change the network architecture by choosing backbones with fewer or more parameters and use pretrainded weights to initialize it:
+
+.. code:: python
+
+    model = sm.Unet('resnet34', encoder_weights='imagenet')
+
+Change number of output classes in the model (choose your case):
+
+.. code:: python
+    
+    # binary segmentation (this parameters are default when you call Unet('resnet34')
+    model = sm.Unet('resnet34', classes=1, activation='sigmoid')
+    
+.. code:: python
+    
+    # multiclass segmentation with non overlapping class masks (your classes + background)
+    model = sm.Unet('resnet34', classes=3, activation='softmax')
+    
+.. code:: python
+    
+    # multiclass segmentation with independent overlapping/non-overlapping class masks
+    model = sm.Unet('resnet34', classes=3, activation='sigmoid')
+    
+    
+Change input shape of the model:
+
+.. code:: python
+    
+    # if you set input channels not equal to 3, you have to set encoder_weights=None
+    # how to handle such case with encoder_weights='imagenet' described in docs
+    model = Unet('resnet34', input_shape=(None, None, 6), encoder_weights=None)
+   
+Simple training pipeline
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    import segmentation_models as sm
+
+    BACKBONE = 'resnet34'
+    preprocess_input = sm.get_preprocessing(BACKBONE)
+
+    # load your data
+    x_train, y_train, x_val, y_val = load_data(...)
+
+    # preprocess input
+    x_train = preprocess_input(x_train)
+    x_val = preprocess_input(x_val)
+
+    # define model
+    model = sm.Unet(BACKBONE, encoder_weights='imagenet')
+    model.compile(
+        'Adam',
+        loss=sm.losses.bce_jaccard_loss,
+        metrics=[sm.metrics.iou_score],
+    )
+
+    # fit model
+    # if you use data generator use model.fit_generator(...) instead of model.fit(...)
+    # more about `fit_generator` here: https://keras.io/models/sequential/#fit_generator
+    model.fit(
+       x=x_train,
+       y=y_train,
+       batch_size=16,
+       epochs=100,
+       validation_data=(x_val, y_val),
+    )
+
+Same manipulations can be done with ``Linknet``, ``PSPNet`` and ``FPN``. For more detailed information about models API and  use cases `Read the Docs <https://segmentation-models.readthedocs.io/en/latest/>`__.
+
+Examples
+~~~~~~~~
+Models training examples:
+ - [Jupyter Notebook] Binary segmentation (`cars`) on CamVid dataset `here <https://github.com/qubvel/segmentation_models/blob/master/examples/binary%20segmentation%20(camvid).ipynb>`__.
+ - [Jupyter Notebook] Multi-class segmentation (`cars`, `pedestrians`) on CamVid dataset `here <https://github.com/qubvel/segmentation_models/blob/master/examples/multiclass%20segmentation%20(camvid).ipynb>`__.
+
+Models and Backbones
+~~~~~~~~~~~~~~~~~~~~
+**Models**
+
+-  `Unet <https://arxiv.org/abs/1505.04597>`__
+-  `FPN <http://presentations.cocodataset.org/COCO17-Stuff-FAIR.pdf>`__
+-  `Linknet <https://arxiv.org/abs/1707.03718>`__
+-  `PSPNet <https://arxiv.org/abs/1612.01105>`__
+
+============= ==============
+Unet          Linknet
+============= ==============
+|unet_image|  |linknet_image|
+============= ==============
+
+============= ==============
+PSPNet        FPN
+============= ==============
+|psp_image|   |fpn_image|
+============= ==============
+
+.. _Unet: https://github.com/qubvel/segmentation_models/blob/readme/LICENSE
+.. _Linknet: https://arxiv.org/abs/1707.03718
+.. _PSPNet: https://arxiv.org/abs/1612.01105
+.. _FPN: http://presentations.cocodataset.org/COCO17-Stuff-FAIR.pdf
+
+.. |unet_image| image:: https://github.com/qubvel/segmentation_models/blob/master/images/unet.png
+.. |linknet_image| image:: https://github.com/qubvel/segmentation_models/blob/master/images/linknet.png
+.. |psp_image| image:: https://github.com/qubvel/segmentation_models/blob/master/images/pspnet.png
+.. |fpn_image| image:: https://github.com/qubvel/segmentation_models/blob/master/images/fpn.png
+
+**Backbones**
+
+.. table:: 
+
+    =============  ===== 
+    Type           Names
+    =============  =====
+    VGG            ``'vgg16' 'vgg19'``
+    ResNet         ``'resnet18' 'resnet34' 'resnet50' 'resnet101' 'resnet152'``
+    SE-ResNet      ``'seresnet18' 'seresnet34' 'seresnet50' 'seresnet101' 'seresnet152'``
+    ResNeXt        ``'resnext50' 'resnext101'``
+    SE-ResNeXt     ``'seresnext50' 'seresnext101'``
+    SENet154       ``'senet154'``
+    DenseNet       ``'densenet121' 'densenet169' 'densenet201'`` 
+    Inception      ``'inceptionv3' 'inceptionresnetv2'``
+    MobileNet      ``'mobilenet' 'mobilenetv2'``
+    EfficientNet   ``'efficientnetb0' 'efficientnetb1' 'efficientnetb2' 'efficientnetb3' 'efficientnetb4' 'efficientnetb5' efficientnetb6' efficientnetb7'``
+    =============  =====
+
+.. epigraph::
+    All backbones have weights trained on 2012 ILSVRC ImageNet dataset (``encoder_weights='imagenet'``). 
+
+
+Installation
+~~~~~~~~~~~~
+
+**Requirements**
+
+1) python 3
+2) keras >= 2.2.0 or tensorflow >= 1.13
+3) keras-applications >= 1.0.7, <=1.0.8
+4) image-classifiers == 1.0.*
+5) efficientnet == 1.0.*
+
+**PyPI stable package**
+
+.. code:: bash
+
+    $ pip install -U segmentation-models
+
+**PyPI latest package**
+
+.. code:: bash
+
+    $ pip install -U --pre segmentation-models
+
+**Source latest version**
+
+.. code:: bash
+
+    $ pip install git+https://github.com/qubvel/segmentation_models
+    
+Documentation
+~~~~~~~~~~~~~
+Latest **documentation** is avaliable on `Read the
+Docs <https://segmentation-models.readthedocs.io/en/latest/>`__
+
+Change Log
+~~~~~~~~~~
+To see important changes between versions look at CHANGELOG.md_
+
+Citing
+~~~~~~~~
+
+.. code::
+
+    @misc{Yakubovskiy:2019,
+      Author = {Pavel Iakubovskii},
+      Title = {Segmentation Models},
+      Year = {2019},
+      Publisher = {GitHub},
+      Journal = {GitHub repository},
+      Howpublished = {\url{https://github.com/qubvel/segmentation_models}}
+    } 
+
+License
+~~~~~~~
+Project is distributed under `MIT Licence`_.
+
+.. _CHANGELOG.md: https://github.com/qubvel/segmentation_models/blob/master/CHANGELOG.md
+.. _`MIT Licence`: https://github.com/qubvel/segmentation_models/blob/master/LICENSE

segmodels_keras-0.1.0.dev0/pyproject.toml

@@ -0,0 +1,63 @@
+[tool.pyright]
+exclude = ["local_ignore", "**/node_modules", "**/__pycache__", "**/.*"]
+ignore = ["*"]
+
+[tool.pytest.ini_options]
+log_level = "DEBUG"
+# Write all logging and warnings immediately while running test with debugger.
+# log_cli = true
+# addopts = "-p no:warnings"
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+extend-exclude = ["docs/conf.py", "local_ignore/*", "examples"]
+
+[tool.ruff.lint]
+select = [
+    "YTT",  # flake8-2020
+    # "ANN",  # flake8-annotations
+    "B",  # flake8-bugbear
+    "A",  # flake8-builtins
+    "C4",  # flake8-comprehensions
+    "T10",  # flake8-debugger
+    "ISC",  # flake8-implicit string concatenation
+    # "G",  # flake8-logging-format
+    "PIE",  # flake8-pie misc lints
+    # "SIM",  # flake8-simplify
+    "TC",  # flake8-type-checking imports
+    "ARG",  # flake8-unused-arguments
+    # "PTH",  # flake8-use-pathlib
+    "FLY",  # flynt
+    "I",  # isort
+    "NPY",  # NumPy-specific rules
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    # "D",  # pydocstyle
+    "F",  # pyflakes
+    "PLC",  # pylint convention
+    "PLE",  # pylint error
+    "PLR",  # pylint refactor
+    "PLW",  # pylint warning
+    "UP",  # pyupgrade
+    "RUF",  # Ruff-specific rules
+]
+
+ignore = [
+    ### Intentionally disabled
+    "E402",     # Module level import not at top of file
+    "PLR0913",  # Too many arguments to function call
+    "PLR0911",  # Too many returns
+    "PLR0912",  # Too many branches
+    "PLR0915",  # Too many statements
+    "PLR2004",  # Magic number
+    "PLR5501",  # Use `elif` instead of `else` then `if`, to reduce indentation
+    "PLW2901",  # Loop variable overwritten by assignment target
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["ANN", "D"]
+"perftests/*" = ["ANN", "D"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"

segmodels_keras-0.1.0.dev0/segmodels_keras/__init__.py

@@ -0,0 +1,132 @@
+import functools
+import os
+
+from . import base
+from .__version__ import __version__
+
+_KERAS_FRAMEWORK_NAME = "keras"
+_TF_KERAS_FRAMEWORK_NAME = "tf.keras"
+
+_DEFAULT_KERAS_FRAMEWORK = _KERAS_FRAMEWORK_NAME
+_KERAS_FRAMEWORK = None
+_KERAS_BACKEND = None
+_KERAS_LAYERS = None
+_KERAS_MODELS = None
+_KERAS_UTILS = None
+_KERAS_LOSSES = None
+
+
+def inject_global_losses(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        kwargs["losses"] = _KERAS_LOSSES
+        return func(*args, **kwargs)
+
+    return wrapper
+
+
+def filter_kwargs(func):
+    @functools.wraps(func)
+    def wrapper(*args, **kwargs):
+        new_kwargs = {
+            k: v
+            for k, v in kwargs.items()
+            if k in ["backend", "layers", "models", "utils"]
+        }
+        return func(*args, **new_kwargs)
+
+    return wrapper
+
+
+def framework():
+    """Return name of Segmentation Models framework"""
+    return _KERAS_FRAMEWORK
+
+
+def set_framework(name):
+    """Set framework for Segmentation Models
+
+    Args:
+        name (str): one of ``keras``, ``tf.keras``, case insensitive.
+
+    Raises:
+        ValueError: in case of incorrect framework name.
+        ImportError: in case framework is not installed.
+
+    """
+    name = name.lower()
+
+    if name == _KERAS_FRAMEWORK_NAME:
+        import keras
+    elif name == _TF_KERAS_FRAMEWORK_NAME:
+        from tensorflow import keras
+    else:
+        raise ValueError(
+            f"Not correct module name `{name}`, use `{_KERAS_FRAMEWORK_NAME}` or "
+            f"`{_TF_KERAS_FRAMEWORK_NAME}`"
+        )
+
+    global _KERAS_BACKEND, _KERAS_LAYERS, _KERAS_MODELS
+    global _KERAS_UTILS, _KERAS_LOSSES, _KERAS_FRAMEWORK
+
+    _KERAS_FRAMEWORK = name
+    _KERAS_BACKEND = keras.backend
+    _KERAS_LAYERS = keras.layers
+    _KERAS_MODELS = keras.models
+    _KERAS_UTILS = keras.utils
+    _KERAS_LOSSES = keras.losses
+
+    # allow losses/metrics get keras submodules
+    base.KerasObject.set_submodules(
+        backend=keras.backend,
+        layers=keras.layers,
+        models=keras.models,
+        utils=keras.utils,
+    )
+
+
+# set default framework
+_framework = os.environ.get("SM_FRAMEWORK", _DEFAULT_KERAS_FRAMEWORK)
+try:
+    set_framework(_framework)
+except ImportError:
+    other = (
+        _TF_KERAS_FRAMEWORK_NAME
+        if _framework == _KERAS_FRAMEWORK_NAME
+        else _KERAS_FRAMEWORK_NAME
+    )
+    set_framework(other)
+
+print(f"Segmentation Models: using `{_KERAS_FRAMEWORK}` framework.")
+
+# import helper modules
+from . import losses, metrics, utils
+
+# wrap segmentation models with framework modules
+from .backbones.backbones_factory import Backbones
+from .models.fpn import FPN
+from .models.linknet import Linknet
+from .models.pspnet import PSPNet
+from .models.unet import Unet
+
+get_available_backbone_names = Backbones.models_names
+
+
+def get_preprocessing(name):
+    return Backbones.get_preprocessing(name)
+
+
+__all__ = [
+    "FPN",
+    "Linknet",
+    "PSPNet",
+    "Unet",
+    "__version__",
+    "framework",
+    "get_available_backbone_names",
+    "get_preprocessing",
+    "losses",
+    "metrics",
+    "set_framework",
+    "utils",
+]

segmodels_keras-0.1.0.dev0/segmodels_keras/__version__.py

@@ -0,0 +1,3 @@
+VERSION = (0, 1, 0, "dev0")
+
+__version__ = ".".join(map(str, VERSION))

segmodels_keras-0.1.0.dev0/segmodels_keras/_compat.py

@@ -0,0 +1,3 @@
+import keras
+
+KERAS_GTE_3 = keras.__version__ >= "3.0.0"