xaitk-saliency-demo


Namexaitk-saliency-demo JSON
Version 2.4.0 PyPI version JSON
download
home_page
SummaryWeb application demonstrating XAITK Saliency functionality
upload_time2023-09-19 22:22:16
maintainer
docs_urlNone
authorKitware Inc.
requires_python
licenseBSD License
keywords python interactive web application framework
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ===================
XAITK Saliency Demo
===================

XAITK Saliency functionality demonstration via an interactive Web UI that can run locally, in jupyter or in the cloud.
A docker image is available for cloud deployment or local testing (``kitware/trame:xaitk``).
This application has been mainly tested on Linux but should work everywhere assuming all the dependencies manage to install on your system.

|image_1| |image_2| |image_3| |image_4|

.. |image_1| image:: https://raw.githubusercontent.com/XAITK/xaitk-saliency-web-demo/master/gallery/xaitk-classification-rise-4.jpg
  :width: 20%
.. |image_2| image:: https://raw.githubusercontent.com/XAITK/xaitk-saliency-web-demo/master/gallery/xaitk-classification-sliding-window.jpg
  :width: 20%
.. |image_3| image:: https://raw.githubusercontent.com/XAITK/xaitk-saliency-web-demo/master/gallery/xaitk-detection-retina.jpg
  :width: 20%
.. |image_4| image:: https://raw.githubusercontent.com/XAITK/xaitk-saliency-web-demo/master/gallery/xaitk-similarity-1.jpg
  :width: 20%


License
-------

This application is provided under the BSD Open Source License.


Installing
----------

On Linux, ``pip`` is enough to install this Python library.

.. code-block:: console

    python3.9 -m venv .venv
    source .venv/bin/activate
    pip install -U pip xaitk-saliency-demo

Then from that virtual-environment you can run the application like below

.. code-block:: console

    # Executable
    xaitk-saliency-demo

    # Module approach
    python -m xaitk_saliency_demo.app

Within Jupyter you can do the following

.. code-block:: console

    from xaitk_saliency_demo.app.jupyter import show
    show()




Docker image
------------

For each commit to master the CI will push a new **kitware/trame:xaitk** image to dockerhub.
Such image can be ran locally using the following command line.

.. code-block:: console

    docker run -it --rm --gpus all -p 8080:80 kitware/trame:xaitk

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "xaitk-saliency-demo",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "Python,Interactive,Web,Application,Framework",
    "author": "Kitware Inc.",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/75/e2/bb391270bff223c65b7b6699975afbefe147cb7f181f643945ed9d1a1bcb/xaitk-saliency-demo-2.4.0.tar.gz",
    "platform": null,
    "description": "===================\nXAITK Saliency Demo\n===================\n\nXAITK Saliency functionality demonstration via an interactive Web UI that can run locally, in jupyter or in the cloud.\nA docker image is available for cloud deployment or local testing (``kitware/trame:xaitk``).\nThis application has been mainly tested on Linux but should work everywhere assuming all the dependencies manage to install on your system.\n\n|image_1| |image_2| |image_3| |image_4|\n\n.. |image_1| image:: https://raw.githubusercontent.com/XAITK/xaitk-saliency-web-demo/master/gallery/xaitk-classification-rise-4.jpg\n  :width: 20%\n.. |image_2| image:: https://raw.githubusercontent.com/XAITK/xaitk-saliency-web-demo/master/gallery/xaitk-classification-sliding-window.jpg\n  :width: 20%\n.. |image_3| image:: https://raw.githubusercontent.com/XAITK/xaitk-saliency-web-demo/master/gallery/xaitk-detection-retina.jpg\n  :width: 20%\n.. |image_4| image:: https://raw.githubusercontent.com/XAITK/xaitk-saliency-web-demo/master/gallery/xaitk-similarity-1.jpg\n  :width: 20%\n\n\nLicense\n-------\n\nThis application is provided under the BSD Open Source License.\n\n\nInstalling\n----------\n\nOn Linux, ``pip`` is enough to install this Python library.\n\n.. code-block:: console\n\n    python3.9 -m venv .venv\n    source .venv/bin/activate\n    pip install -U pip xaitk-saliency-demo\n\nThen from that virtual-environment you can run the application like below\n\n.. code-block:: console\n\n    # Executable\n    xaitk-saliency-demo\n\n    # Module approach\n    python -m xaitk_saliency_demo.app\n\nWithin Jupyter you can do the following\n\n.. code-block:: console\n\n    from xaitk_saliency_demo.app.jupyter import show\n    show()\n\n\n\n\nDocker image\n------------\n\nFor each commit to master the CI will push a new **kitware/trame:xaitk** image to dockerhub.\nSuch image can be ran locally using the following command line.\n\n.. code-block:: console\n\n    docker run -it --rm --gpus all -p 8080:80 kitware/trame:xaitk\n",
    "bugtrack_url": null,
    "license": "BSD License",
    "summary": "Web application demonstrating XAITK Saliency functionality",
    "version": "2.4.0",
    "project_urls": null,
    "split_keywords": [
        "python",
        "interactive",
        "web",
        "application",
        "framework"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1e0f0f4b1d35fd013fa251986051913f352396a98975070dab3e5eeec50a2e70",
                "md5": "49a1bdd6726ed41389bf933e93aba26d",
                "sha256": "ad059972cda6fa7d2831dac5c3cb91052ff7cd0d3490d5ac9ba8c8d2a755b4fc"
            },
            "downloads": -1,
            "filename": "xaitk_saliency_demo-2.4.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "49a1bdd6726ed41389bf933e93aba26d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 25145,
            "upload_time": "2023-09-19T22:22:13",
            "upload_time_iso_8601": "2023-09-19T22:22:13.849784Z",
            "url": "https://files.pythonhosted.org/packages/1e/0f/0f4b1d35fd013fa251986051913f352396a98975070dab3e5eeec50a2e70/xaitk_saliency_demo-2.4.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "75e2bb391270bff223c65b7b6699975afbefe147cb7f181f643945ed9d1a1bcb",
                "md5": "cdfde262a5d92b8545ac8cc5087dabf2",
                "sha256": "a7e445ed29973af84c63030a2cc918b470e97bd2a6bb4d400a36461345e57633"
            },
            "downloads": -1,
            "filename": "xaitk-saliency-demo-2.4.0.tar.gz",
            "has_sig": false,
            "md5_digest": "cdfde262a5d92b8545ac8cc5087dabf2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 23145,
            "upload_time": "2023-09-19T22:22:16",
            "upload_time_iso_8601": "2023-09-19T22:22:16.036568Z",
            "url": "https://files.pythonhosted.org/packages/75/e2/bb391270bff223c65b7b6699975afbefe147cb7f181f643945ed9d1a1bcb/xaitk-saliency-demo-2.4.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-19 22:22:16",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "xaitk-saliency-demo"
}
        
Elapsed time: 0.37760s