README.rst 882 B

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