Version Logs

v2.1.0 : Minor Release - Refactoring, Add Docs, Add Tests

  • ReadTheDocs integration.

  • Removal of deprecated codebase.

  • Removal of README_old.md

  • Removal of deprecated files.

  • Add tests/ to house tests.

  • Update setup.py & setup_dev.py files for packages parameter.

  • Update Release Logs.

v2.0.0 : Major Release - Refactoring, New Engines, Abstraction Addition (Py36, Py37, Py38, Py39 & Py310 Compatible)

  • Following refactoring Additions/Changes were made:

    • Core algorithms moved to core.py

    • Older files deprecated and names changed, these files would be removed in v2.0.1

      • bubble_bbox.py → _bubble_bbox.py

      • swt.py → _swt.py

      • utils.py → _utils.py

    • Add README.md (v2.0.0 onwards)

    • Add History.md : File to house history logs

    • Add Usage.md : Gives overview of the usage of the package

    • Newer files added:

      • core.py : To house all the core algorithms - findStrokes, Fusion.

      • abstractions.py : To house all the abstractions - SWTImage, Letter and Word.

  • Dependency Changes

    • (+) Numba

    • (-) imutils

  • Algorithmic Changes:

    • (+/-) Major deprecation in SWTLocalizer, almost all codebase moved to other locations. This will be, henceforth, a driver class.

    • (+) New abstractions.py file:

      • Addition of class SWTImage - An abstraction for an individual images sent in for processing. Has following major functions :

        • transformImage : To transform the original image to its stroke widths (*1)

        • localizeLetters : To localize letters

        • localizeWords : To letters into words

        • getLetter : To retrieve an individual letters

        • letterIterator : Returns a generator over all the letters with visualization capabilities

        • getWord : To retrieve an individual word

        • wordIterator : Returns a generator over all the words with visualization capabilities

        • saveCrop : To crop and save a letter or a word

        • showImage: To display one/multiple images using the Image Codes defined in configs.py, also has the ability to save the prepared image

      • Addition of class Letter - Represent and houses properties of possible letters

        • Functionality : Add various localization annotation to input image

      • Addition of class Words - Represent and houses properties of possible words

        • Functionality : Add various localization annotation to input image

    • (+) New core.py file

      • Addition of swt_strokes & swt_strokes_jitted function corresponding to the python and numba engines

      • Addition of Fusion & ProxyLetter for grouping of letters into probable letters

    • (+) New base.py file

      • Addition of IndividualComponentBase : A base class to be inherited by Letter

      • Addition of GroupedComponentsBase : A base class to be inherited by Word

      • Addition of TextTransformBase : A base class to be inherited by SWTImage

    • (+) New configs.py file

      • Houses configurations for the Stroke Width Transform

    • (+) Add Improvements in v2.0.0.ipynb notebook

    • (+) Add README Code Blocks.ipynb notebook

    • (+) Add QnA [v2.0.0 onwards].ipynb notebook

    • (+) Add SWTloc Usage [v2.0.0 onwards].ipynb notebook

v1.1.1 : Refine Versioning System

  • New versioning system defined : x[Major Update].x[Minor Update].x[Fixes]

  • Tag 1.1.x Represents all bug fixed versions of 1.1.

  • Bug Fixes

v1.0.0.3 : Add Individual Image Processing

  • Functionality to transform pre-loaded image

  • Minor Bug Fixes

  • Add support for Python 3.6

  • Reduce Dependency

v1.0.0.2 : Few bug fixes and addendum’s

  • Add parameter to govern the width of BubbleBBox

  • Add Examples - StackOverflow Q/A

  • Add image resizing utility function to the utils.py

v1.0.0.1 : Original Package

  • Add SWTlocaliser to the package

  • Add the logic for Bubble Bounding Boxes

  • Add Examples

(+) -> Addition (-) -> Deletion (+/-) -> Modification