README.rst 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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 ipfml
  8. How to use ?
  9. ------------
  10. To use, simply do :
  11. .. code:: python
  12. from PIL import Image
  13. from ipfml.processing import transform
  14. img = Image.open('path/to/image.png')
  15. s = transform.get_LAB_L_SVD_s(img)
  16. Modules
  17. -------
  18. This project contains modules.
  19. - **metrics** : *Metrics computation for model performance*
  20. - **utils** : *All utils functions developed for the package*
  21. - **exceptions** : *All customized exceptions*
  22. - **filters** : *Image filter module with convolution*
  23. - **iqa** : *Image quality assessments*
  24. - **processing** : *Image processing module*
  25. All these modules will be enhanced during development of the package.
  26. Documentation
  27. -------------
  28. For more information about package, documentation_ is available.
  29. .. _documentation: https://prise-3d.github.io/ipfml/
  30. Contributing
  31. ------------
  32. Please refer to the guidelines_ file if you want to contribute!
  33. .. _guidelines: https://github.com/prise-3d/ipfml/blob/master/CONTRIBUTING.md