README.rst 1.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. Image Processing For Machine Learning
  2. =====================================
  3. This is a package developed during a thesis project.
  4. Installation
  5. ------------
  6. .. code:: bash
  7. pip install ifpml
  8. How to use ?
  9. ------------
  10. To use, simply do :
  11. .. code:: python
  12. from PIL import Image
  13. from ipfml import processing
  14. img = Image.open('path/to/image.png')
  15. s = processing.get_LAB_L_SVD_s(img)
  16. Modules
  17. -------
  18. This project contains modules.
  19. - **processing** : *Image processing of images*
  20. - **metrics** : *Metrics computation of PIL or 2D, 3D numpy images*
  21. - **filters** : *Filters implemented such as noise filters*
  22. All these modules will be enhanced during development of the package.
  23. Documentation
  24. -------------
  25. For more information about package, documentation_ is available.
  26. .. _documentation: https://jbuisine.github.io/IPFML/
  27. Contribution
  28. ------------
  29. Please refer to the CONTRIBUTION.md_ file if you want to contribute!
  30. .. _CONTRIBUTION.md: https://github.com/jbuisine/IPFML/blob/master/CONTRIBUTION.md