Spaces:
Sleeping
Sleeping
Fixed app_file path + hyperlinks in README
Browse files
README.md
CHANGED
|
@@ -7,7 +7,7 @@ app_port: 7860
|
|
| 7 |
emoji: 🧠
|
| 8 |
pinned: false
|
| 9 |
license: mit
|
| 10 |
-
app_file: app.py
|
| 11 |
---
|
| 12 |
|
| 13 |
<div align="center">
|
|
@@ -22,19 +22,19 @@ app_file: app.py
|
|
| 22 |
|
| 23 |
</div>
|
| 24 |
|
| 25 |
-
## Brief intro
|
| 26 |
|
| 27 |
This web application enables users to easily test our deep learning model for airway segmentation in CTs. The plugin is built on top of gradio using the same backend as used for the [Raidionics](https://raidionics.github.io/) software. Raidionics is an open-source, free-to-use desktop application for pre- and postoperative central nervous system tumor segmentation and standardized reporting, but the same core backend principles can easily be adapted to other applications, as demonstrated in this repository.
|
| 28 |
|
| 29 |
-
## Demo <a target="_blank" href="https://huggingface.co/spaces/andreped/AeroPath"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>
|
| 30 |
|
| 31 |
To access the live demo, click on the `Hugging Face` badge above. Below is a snapshot of the current state of the demo app.
|
| 32 |
|
| 33 |
<img width="1722" alt="Screenshot 2023-06-06 at 21 53 25" src="https://github.com/andreped/AeroPath/assets/29090665/e67f35c2-482b-409c-b1a9-bc987fbb5c6a">
|
| 34 |
|
| 35 |
-
## Development
|
| 36 |
|
| 37 |
-
### Docker
|
| 38 |
|
| 39 |
Alternatively, you can deploy the software locally. Note that this is only relevant for development purposes. Simply dockerize the app and run it:
|
| 40 |
|
|
@@ -45,7 +45,7 @@ docker run -it -p 7860:7860 AeroPath
|
|
| 45 |
|
| 46 |
Then open `http://127.0.0.1:7860` in your favourite internet browser to view the demo.
|
| 47 |
|
| 48 |
-
### Python
|
| 49 |
|
| 50 |
It is also possible to run the app locally without Docker. Just setup a virtual environment and run the app.
|
| 51 |
Note that the current working directory would need to be adjusted based on where `AeroPath` is located on disk.
|
|
@@ -61,21 +61,13 @@ pip install -r requirements.txt
|
|
| 61 |
python app.py --cwd ./
|
| 62 |
```
|
| 63 |
|
| 64 |
-
|
| 65 |
-
|
| 66 |
-
To aid people developing in the cloud, we have made a simple Jupyter Notebook example which is hosted on Google CoLab.
|
| 67 |
-
|
| 68 |
-
Click the badge above to access it. This is mainly of interest to developers.
|
| 69 |
-
|
| 70 |
-
## Troubleshooting
|
| 71 |
|
| 72 |
Due to `share=True` being enabled by default when launching the app,
|
| 73 |
internet access is required for the app to be launched. This can disabled by setting
|
| 74 |
the argument to `--share 0`.
|
| 75 |
|
| 76 |
-
## Citation
|
| 77 |
-
|
| 78 |
-
## [How to cite](https://github.com/raidionics/Raidionics#how-to-cite)
|
| 79 |
|
| 80 |
If you found this tool relevant in your research, please cite the following references enabling the backend compute magic.
|
| 81 |
|
|
|
|
| 7 |
emoji: 🧠
|
| 8 |
pinned: false
|
| 9 |
license: mit
|
| 10 |
+
app_file: demo/app.py
|
| 11 |
---
|
| 12 |
|
| 13 |
<div align="center">
|
|
|
|
| 22 |
|
| 23 |
</div>
|
| 24 |
|
| 25 |
+
## [Brief intro](https://github.com/raidionics/AeroPath#brief-intro)
|
| 26 |
|
| 27 |
This web application enables users to easily test our deep learning model for airway segmentation in CTs. The plugin is built on top of gradio using the same backend as used for the [Raidionics](https://raidionics.github.io/) software. Raidionics is an open-source, free-to-use desktop application for pre- and postoperative central nervous system tumor segmentation and standardized reporting, but the same core backend principles can easily be adapted to other applications, as demonstrated in this repository.
|
| 28 |
|
| 29 |
+
## [Demo](https://github.com/raidionics/AeroPath#demo) <a target="_blank" href="https://huggingface.co/spaces/andreped/AeroPath"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg"></a>
|
| 30 |
|
| 31 |
To access the live demo, click on the `Hugging Face` badge above. Below is a snapshot of the current state of the demo app.
|
| 32 |
|
| 33 |
<img width="1722" alt="Screenshot 2023-06-06 at 21 53 25" src="https://github.com/andreped/AeroPath/assets/29090665/e67f35c2-482b-409c-b1a9-bc987fbb5c6a">
|
| 34 |
|
| 35 |
+
## [Development](https://github.com/raidionics/AeroPath#development)
|
| 36 |
|
| 37 |
+
### [Docker](https://github.com/raidionics/AeroPath#docker)
|
| 38 |
|
| 39 |
Alternatively, you can deploy the software locally. Note that this is only relevant for development purposes. Simply dockerize the app and run it:
|
| 40 |
|
|
|
|
| 45 |
|
| 46 |
Then open `http://127.0.0.1:7860` in your favourite internet browser to view the demo.
|
| 47 |
|
| 48 |
+
### [Python](https://github.com/raidionics/AeroPath#python)
|
| 49 |
|
| 50 |
It is also possible to run the app locally without Docker. Just setup a virtual environment and run the app.
|
| 51 |
Note that the current working directory would need to be adjusted based on where `AeroPath` is located on disk.
|
|
|
|
| 61 |
python app.py --cwd ./
|
| 62 |
```
|
| 63 |
|
| 64 |
+
## [Troubleshooting](https://github.com/raidionics/AeroPath#troubleshooting)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 65 |
|
| 66 |
Due to `share=True` being enabled by default when launching the app,
|
| 67 |
internet access is required for the app to be launched. This can disabled by setting
|
| 68 |
the argument to `--share 0`.
|
| 69 |
|
| 70 |
+
## [Citation](https://github.com/raidionics/AeroPath#citation)
|
|
|
|
|
|
|
| 71 |
|
| 72 |
If you found this tool relevant in your research, please cite the following references enabling the backend compute magic.
|
| 73 |
|