{"id":19215849,"url":"https://github.com/vanvalenlab/kiosk-console","last_synced_at":"2025-05-12T23:27:40.991Z","repository":{"id":37848465,"uuid":"142951469","full_name":"vanvalenlab/kiosk-console","owner":"vanvalenlab","description":"DeepCell Kiosk Distribution for Kubernetes on GKE and AWS","archived":false,"fork":false,"pushed_at":"2023-07-12T23:38:51.000Z","size":19568,"stargazers_count":35,"open_issues_count":15,"forks_count":6,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-20T19:38:03.176Z","etag":null,"topics":["helm","helmfile","kubernetes","tensorflow-serving"],"latest_commit_sha":null,"homepage":"https://deepcell-kiosk.readthedocs.io","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vanvalenlab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-07-31T02:24:22.000Z","updated_at":"2023-11-08T03:41:33.000Z","dependencies_parsed_at":"2025-04-22T01:48:00.346Z","dependency_job_id":null,"html_url":"https://github.com/vanvalenlab/kiosk-console","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanvalenlab%2Fkiosk-console","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanvalenlab%2Fkiosk-console/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanvalenlab%2Fkiosk-console/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanvalenlab%2Fkiosk-console/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vanvalenlab","download_url":"https://codeload.github.com/vanvalenlab/kiosk-console/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253839357,"owners_count":21972316,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["helm","helmfile","kubernetes","tensorflow-serving"],"created_at":"2024-11-09T14:14:59.100Z","updated_at":"2025-05-12T23:27:40.972Z","avatar_url":"https://github.com/vanvalenlab.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![DeepCell Kiosk Banner](https://raw.githubusercontent.com/vanvalenlab/kiosk-console/master/docs/images/DeepCell_Kiosk_Banner.png)\n\n[![Build Status](https://github.com/vanvalenlab/kiosk-console/workflows/build/badge.svg)](https://github.com/vanvalenlab/kiosk-console/actions)\n[![Read the Docs](https://readthedocs.org/projects/deepcell-kiosk/badge/?version=master)](https://deepcell-kiosk.readthedocs.io/en/master/?badge=master)\n[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/vanvalenlab/kiosk-console/blob/master/LICENSE)\n\nThe `kiosk-console` is the entry point for users to spin up a DeepCell Kiosk, a cloud-native implementation of the DeepCell ecosystem.\n\nThe DeepCell Kiosk is designed to allow researchers to easily deploy and scale a deep learning platform for biological image analysis. Once launched, users can drag-and-drop images to be processed in parallel using publicly available, or custom-built, TensorFlow models. To train custom models, please refer to [deepcell-tf](https://github.com/vanvalenlab/deepcell-tf), which was designed to facilitate model development and is capable of exporting these models for use with the DeepCell Kiosk.\n\nThe scalability of the DeepCell Kiosk software is enabled by [Kubernetes](https://kubernetes.io/). At present, the Kiosk is only compatible with [Google Cloud](https://cloud.google.com/).\n\nAn example of the DeepCell Kiosk is live at [DeepCell.org](https://deepcell.org).\n\n## Features\n\n- Cloud-based deployment of deep-learning models\n- Scalable platform that minimizes cost and inference time\n- Drag and drop interface for running predictions\n\n### Examples\n\n\u003ctable width=\"700\" border=\"1\" cellpadding=\"5\"\u003e\n\n\u003ctr\u003e\n\u003ctd align=\"center\" valign=\"center\"\u003e\nRaw Image\n\u003c/td\u003e\n\n\u003ctd align=\"center\" valign=\"center\"\u003e\nTracked Image\n\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n\u003ctd align=\"center\" valign=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/vanvalenlab/deepcell-tf/master/docs/images/raw.gif\" alt=\"Raw Image\" /\u003e\n\u003c/td\u003e\n\n\u003ctd align=\"center\" valign=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/vanvalenlab/deepcell-tf/master/docs/images/tracked.gif\" alt=\"Tracked Image\" /\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003c/table\u003e\n\n## Getting Started\n\nStart a terminal shell and install the DeepCell Kiosk wrapper script:\n\n```bash\ndocker run -e DOCKER_TAG=1.8.1 vanvalenlab/kiosk-console:1.8.1 | sudo bash\n```\n\nTo start the kiosk, just run `kiosk-console` from the terminal shell.\n\nCheck out our [docs](https://deepcell-kiosk.readthedocs.io/en/master/GETTING_STARTED.html) for more information on how to start your own kiosk.\n\n## Software Architecture\n\n![Kiosk Architecture](https://raw.githubusercontent.com/vanvalenlab/kiosk-console/master/docs/images/Kiosk_Architecture.png)\n\n- [Consumer](https://github.com/vanvalenlab/kiosk-redis-consumer): Retrieves items from the Job Queue and handles the processing pipeline for that item. Each consumer only works on one item at a time.\n\n- [Model Server](https://github.com/vanvalenlab/kiosk-tf-serving): Serves models over a gRPC API, allowing consumers to send data and get back predictions.\n\n- [GPU Autoscaler](https://github.com/vanvalenlab/kiosk-autoscaler): Automatically and efficiently scales Kubernetes GPU resources.\n\n- [Frontend](https://github.com/vanvalenlab/kiosk-frontend): API for creating and managing jobs, and a React-based web interface for the DeepCell Kiosk.\n\n- _Additional Data Entry Tools_:\n\n  - [ImageJ Plugin](https://github.com/vanvalenlab/kiosk-imageJ-plugin): An ImageJ 1.x plugin for processing images with an existing cluster.\n\n  - [Command-line Interface](https://github.com/vanvalenlab/kiosk-client): A python-based CLI for submitting and managing DeepCell Kiosk jobs.\n\n- _Not pictured above_:\n\n  - [Bucket Monitor](https://github.com/vanvalenlab/kiosk-bucket-monitor): Purges the bucket of uploaded and processed files that are older than `AGE_THRESHOLD`, 3 days by default.\n\n  - [Janitor](https://github.com/vanvalenlab/kiosk-redis-janitor): Monitors in-progress items and makes sure no jobs get left un-finished.\n\n## Contribute\n\nWe welcome contributions to the kiosk. If you are interested, please refer to our [Developer Documentation](https://deepcell-kiosk.readthedocs.io/en/master/DEVELOPER.html), [Code of Conduct](https://github.com/vanvalenlab/kiosk-console/blob/master/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/vanvalenlab/kiosk-console/blob/master/CONTRIBUTING.md).\n\n## Support\n\nIssues are managed through [Github](https://github.com/vanvalenlab/kiosk-console/issues).\nDocumentation is hosted on [Read the Docs](https://deepcell-kiosk.readthedocs.io/en/master).\nA [FAQ](http://www.deepcell.org/faq) page is also available.\n\n## License\n\nThis software is license under a modified Apache-2.0 license. See [LICENSE](https://github.com/vanvalenlab/kiosk-console/blob/master/LICENSE) for full details.\n\n## Trademarks\n\nAll other trademarks referenced herein are the property of their respective owners.\n\n## Credits\n\n[![Caltech Logo](https://upload.wikimedia.org/wikipedia/commons/7/75/Caltech_Logo.svg)](http://www.vanvalen.caltech.edu/)\n\nThis kiosk was developed with [Cloud Posse, LLC](https://cloudposse.com). They can be reached at \u003chello@cloudposse.com\u003e\n\n## Copyright\n\nCopyright © 2018-2022 [The Van Valen Lab](http://www.vanvalen.caltech.edu/) at the California Institute of Technology (Caltech), with support from the Shurl and Kay Curci Foundation, the Paul Allen Family Foundation, Google, \u0026 National Institutes of Health (NIH) under Grant U24CA224309-01.\nAll rights reserved.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanvalenlab%2Fkiosk-console","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvanvalenlab%2Fkiosk-console","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanvalenlab%2Fkiosk-console/lists"}