===================
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 create_app
xaitk = await create_app()
xaitk.gui
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": null,
"name": "xaitk-saliency-demo",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Python, Interactive, Web, Application, Framework",
"author": "Kitware Inc.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3d/d4/c7f10611b28b9664e53c58cf695dc93e63d56a7122d3f16d24f49772bcd2/xaitk_saliency_demo-2.5.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 create_app\n xaitk = await create_app()\n xaitk.gui\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.5.0",
"project_urls": null,
"split_keywords": [
"python",
" interactive",
" web",
" application",
" framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e4028942e3d3f6d1ad5da0c8db9c86218ada5db5ed57bc9d28e03fe1e28a57d",
"md5": "6a8f08ff1bf83502700a5091efafa9ff",
"sha256": "59c753e3fc4e4789a71bf0353733f3818204f43bc94f51f1a6fbb7a1ab631679"
},
"downloads": -1,
"filename": "xaitk_saliency_demo-2.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a8f08ff1bf83502700a5091efafa9ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 26737,
"upload_time": "2025-02-12T00:55:15",
"upload_time_iso_8601": "2025-02-12T00:55:15.139967Z",
"url": "https://files.pythonhosted.org/packages/2e/40/28942e3d3f6d1ad5da0c8db9c86218ada5db5ed57bc9d28e03fe1e28a57d/xaitk_saliency_demo-2.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3dd4c7f10611b28b9664e53c58cf695dc93e63d56a7122d3f16d24f49772bcd2",
"md5": "5866b049c0906602a66555257a50f286",
"sha256": "978fad560337430d325574fce53349140cd1245d9931598e072d70a4ba6f59f1"
},
"downloads": -1,
"filename": "xaitk_saliency_demo-2.5.0.tar.gz",
"has_sig": false,
"md5_digest": "5866b049c0906602a66555257a50f286",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24602,
"upload_time": "2025-02-12T00:55:17",
"upload_time_iso_8601": "2025-02-12T00:55:17.990448Z",
"url": "https://files.pythonhosted.org/packages/3d/d4/c7f10611b28b9664e53c58cf695dc93e63d56a7122d3f16d24f49772bcd2/xaitk_saliency_demo-2.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-12 00:55:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "xaitk-saliency-demo"
}
JSON