Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 3.3 KB

README.adoc

File metadata and controls

56 lines (41 loc) · 3.3 KB

paddle (PArticle Detection via Deep LEarning)


⚠️ DEPRECATED ⚠️

Unfortunately, I cannot provide support for paddle any longer. Fortunately, there has been a lot of progress in the meantime, with regard to the usability of Mask R-CNN for custom applications, such as image-based particle detection. Therefore, I recommend to use the mmdetection framework, which has a large community, a thorough documentation and a huge model zoo. If you plan to train on your own data, this is a good place to get started.


j.powtec.2019.10.020 blue arXiv 1907.05112 b31b1b paddle code%20style black 000000

This repository is a toolbox for the easy, deep learning-based primary particle size analysis of agglomerated, aggregated, partially sintered or simply occluded particles. It is the successor of the DeepParticleNet toolbox, which accompanies the following publication:

Example Detection
Example PSD Measurement

The utilized convolutional neural network is based on the Mask R-CNN architecture, developed by He et al.. It was implemented using PyTorch, torchvision and PyTorchLightning.

Installation

  1. Install conda for your operating system.

  2. Open a command line.

  3. Clone this repository: git clone https://github.com/maxfrei750/paddle.git

  4. Change into the folder of the repository: cd paddle

  5. Create a new conda environment: conda env create --file environment.yaml

  6. Activate the conda environment: activate paddle

  7. Install paddle into the environment: pip install --editable .

Tip
Creating the environment with conda can take a while. Using mamba can speed up the creation significantly.

Getting started

  1. Open a command line.

  2. Activate the conda environment: activate paddle

  3. Start JupyterLab: jupyter lab and click one of the links to access the JupyterLab server.

  4. In JupyterLab, navigate to the paddle/demos folder and choose a demo of your liking.

Citation

If you use this repository for a publication, then please cite it using the following bibtex-entry:

@article{Frei.2019,
    author = {Frei, Max and Kruis, Frank Einar},
    year = {2019},
    title = {Image-Based Size Analysis of Agglomerated and Partially Sintered Particles via Convolutional Neural Networks},
    url = {https://doi.org/10.1016/j.powtec.2019.10.020}
}