edgarriba commited on
Commit
3649cf1
1 Parent(s): 0cd80fe

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +42 -45
README.md CHANGED
@@ -8,66 +8,56 @@ pinned: false
8
  ---
9
  <div align="center">
10
  <p align="center">
11
- <img width="75%" src="https://github.com/kornia/data/raw/main/kornia_banner_pixie.png" />
12
  </p>
13
 
14
- *Kornia* is a differentiable computer vision library for [PyTorch](https://pytorch.org).
15
 
16
- It consists of a set of routines and differentiable modules to solve generic computer vision problems. At its core, the package uses *PyTorch* as its main backend both for efficiency and to take advantage of the reverse-mode auto-differentiation to define and compute the gradient of complex functions.
17
 
18
- <div align="center">
19
- <img src="https://github.com/kornia/kornia/raw/master/docs/source/_static/img/hakuna_matata.gif" width="75%" height="75%">
 
 
 
 
 
 
 
20
  </div>
21
 
22
- <!--<div align="center">
23
- <img src="http://drive.google.com/uc?export=view&id=1KNwaanUdY1MynF0EYfyXjDM3ti09tzaq">
24
- </div>-->
25
 
26
- ## Overview
27
 
28
  Inspired by existing packages, this library is composed by a subset of packages containing operators that can be inserted within neural networks to train models to perform image transformations, epipolar geometry, depth estimation, and low-level image processing such as filtering and edge detection that operate directly on tensors.
29
 
30
- At a granular level, Kornia is a library that consists of the following components:
31
-
32
- | **Component** | **Description** |
33
- |----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
34
- | [kornia](https://kornia.readthedocs.io/en/latest/index.html) | a Differentiable Computer Vision library, with strong GPU support |
35
- | [kornia.augmentation](https://kornia.readthedocs.io/en/latest/augmentation.html) | a module to perform data augmentation in the GPU |
36
- | [kornia.color](https://kornia.readthedocs.io/en/latest/color.html) | a set of routines to perform color space conversions |
37
- | [kornia.contrib](https://kornia.readthedocs.io/en/latest/contrib.html) | a compilation of user contrib and experimental operators |
38
- | [kornia.enhance](https://kornia.readthedocs.io/en/latest/enhance.html) | a module to perform normalization and intensity transformation |
39
- | [kornia.feature](https://kornia.readthedocs.io/en/latest/feature.html) | a module to perform feature detection |
40
- | [kornia.filters](https://kornia.readthedocs.io/en/latest/filters.html) | a module to perform image filtering and edge detection |
41
- | [kornia.geometry](https://kornia.readthedocs.io/en/latest/geometry.html) | a geometric computer vision library to perform image transformations, 3D linear algebra and conversions using different camera models |
42
- | [kornia.losses](https://kornia.readthedocs.io/en/latest/losses.html) | a stack of loss functions to solve different vision tasks |
43
- | [kornia.morphology](https://kornia.readthedocs.io/en/latest/morphology.html) | a module to perform morphological operations |
44
- | [kornia.utils](https://kornia.readthedocs.io/en/latest/utils.html) | image to tensor utilities and metrics for vision problems |
45
 
46
  ## Installation
47
 
48
- ### From pip:
49
 
50
  ```bash
51
  pip install kornia
52
- pip install kornia[x] # to get the training API !
53
  ```
54
 
55
  <details>
56
  <summary>Other installation options</summary>
57
 
58
- #### From source:
59
-
60
- ```bash
61
- python setup.py install
62
- ```
63
-
64
- #### From source with symbolic links:
65
 
66
  ```bash
67
  pip install -e .
68
  ```
69
 
70
- #### From source using pip:
71
 
72
  ```bash
73
  pip install git+https://github.com/kornia/kornia
@@ -75,30 +65,37 @@ At a granular level, Kornia is a library that consists of the following componen
75
 
76
  </details>
77
 
 
78
 
79
- ## Examples
80
 
81
- Run our Jupyter notebooks [tutorials](https://kornia-tutorials.readthedocs.io/en/latest/) to learn to use the library.
82
-
83
- <div align="center">
84
- <a href="https://colab.research.google.com/github/kornia/tutorials/blob/master/source/hello_world_tutorial.ipynb" target="_blank">
85
- <img src="https://raw.githubusercontent.com/kornia/data/main/hello_world_arturito.png" width="75%" height="75%">
86
- </a>
87
- </div>
 
 
88
 
89
  ## Contributing
90
- We appreciate all contributions. If you are planning to contribute back bug-fixes, please do so without any further discussion. If you plan to contribute new features, utility functions or extensions, please first open an issue and discuss the feature with us. Please, consider reading the [CONTRIBUTING](https://github.com/kornia/kornia/blob/master/CONTRIBUTING.rst) notes. The participation in this open source project is subject to [Code of Conduct](https://github.com/kornia/kornia/blob/master/CODE_OF_CONDUCT.md).
91
 
 
92
 
93
  ## Community
 
94
  - **Forums:** discuss implementations, research, etc. [GitHub Forums](https://github.com/kornia/kornia/discussions)
95
  - **GitHub Issues:** bug reports, feature requests, install issues, RFCs, thoughts, etc. [OPEN](https://github.com/kornia/kornia/issues/new/choose)
96
  - **Slack:** Join our workspace to keep in touch with our core contributors and be part of our community. [JOIN HERE](https://join.slack.com/t/kornia/shared_invite/zt-csobk21g-2AQRi~X9Uu6PLMuUZdvfjA)
97
- - For general information, please visit our website at www.kornia.org
98
 
99
  <a href="https://github.com/Kornia/kornia/graphs/contributors">
100
- <img src="https://contrib.rocks/image?repo=Kornia/kornia" width="75%" height="75%" />
101
  </a>
102
 
103
  Made with [contrib.rocks](https://contrib.rocks).
104
 
 
 
 
 
 
8
  ---
9
  <div align="center">
10
  <p align="center">
11
+ <img width="55%" src="https://github.com/kornia/data/raw/main/kornia_banner_pixie.png" />
12
  </p>
13
 
14
+ ---
15
 
16
+ English | [简体中文](README_zh-CN.md)
17
 
18
+ <!-- prettier-ignore -->
19
+ <a href="https://kornia.readthedocs.io">Docs</a>
20
+ <a href="https://colab.sandbox.google.com/github/kornia/tutorials/blob/master/nbs/hello_world_tutorial.ipynb">Try it Now</a> •
21
+ <a href="https://kornia.github.io/tutorials/">Tutorials</a> •
22
+ <a href="https://github.com/kornia/kornia-examples">Examples</a> •
23
+ <a href="https://kornia.github.io//kornia-blog">Blog</a> •
24
+ <a href="https://join.slack.com/t/kornia/shared_invite/zt-csobk21g-CnydWe5fmvkcktIeRFGCEQ">Community</a>
25
+
26
+ </p>
27
  </div>
28
 
29
+ **Kornia** is a differentiable computer vision library for [PyTorch](https://pytorch.org).
 
 
30
 
31
+ It consists of a set of routines and differentiable modules to solve generic computer vision problems. At its core, the package uses *PyTorch* as its main backend both for efficiency and to take advantage of the reverse-mode auto-differentiation to define and compute the gradient of complex functions.
32
 
33
  Inspired by existing packages, this library is composed by a subset of packages containing operators that can be inserted within neural networks to train models to perform image transformations, epipolar geometry, depth estimation, and low-level image processing such as filtering and edge detection that operate directly on tensors.
34
 
35
+ ## Sponsorship
36
+
37
+ Kornia is an open-source project that is developed and maintained by volunteers. Whether you're using it for research or commercial purposes, consider sponsoring or collaborating with us. Your support will help ensure Kornia's growth and ongoing innovation. Reach out to us today and be a part of shaping the future of this exciting initiative!
38
+
39
+ <a href="https://opencollective.com/kornia/donate" target="_blank">
40
+ <img src="https://opencollective.com/webpack/donate/button@2x.png?color=blue" width=300 />
41
+ </a>
 
 
 
 
 
 
 
 
42
 
43
  ## Installation
44
 
45
+ ### From pip
46
 
47
  ```bash
48
  pip install kornia
 
49
  ```
50
 
51
  <details>
52
  <summary>Other installation options</summary>
53
 
54
+ #### From source with editable mode
 
 
 
 
 
 
55
 
56
  ```bash
57
  pip install -e .
58
  ```
59
 
60
+ #### From Github url (latest version)
61
 
62
  ```bash
63
  pip install git+https://github.com/kornia/kornia
 
65
 
66
  </details>
67
 
68
+ ## Cite
69
 
70
+ If you are using kornia in your research-related documents, it is recommended that you cite the paper. See more in [CITATION](./CITATION.md).
71
 
72
+ ```bibtex
73
+ @inproceedings{eriba2019kornia,
74
+ author = {E. Riba, D. Mishkin, D. Ponsa, E. Rublee and G. Bradski},
75
+ title = {Kornia: an Open Source Differentiable Computer Vision Library for PyTorch},
76
+ booktitle = {Winter Conference on Applications of Computer Vision},
77
+ year = {2020},
78
+ url = {https://arxiv.org/pdf/1910.02190.pdf}
79
+ }
80
+ ```
81
 
82
  ## Contributing
 
83
 
84
+ We appreciate all contributions. If you are planning to contribute back bug-fixes, please do so without any further discussion. If you plan to contribute new features, utility functions or extensions, please first open an issue and discuss the feature with us. Please, consider reading the [CONTRIBUTING](./CONTRIBUTING.md) notes. The participation in this open source project is subject to [Code of Conduct](./CODE_OF_CONDUCT.md).
85
 
86
  ## Community
87
+
88
  - **Forums:** discuss implementations, research, etc. [GitHub Forums](https://github.com/kornia/kornia/discussions)
89
  - **GitHub Issues:** bug reports, feature requests, install issues, RFCs, thoughts, etc. [OPEN](https://github.com/kornia/kornia/issues/new/choose)
90
  - **Slack:** Join our workspace to keep in touch with our core contributors and be part of our community. [JOIN HERE](https://join.slack.com/t/kornia/shared_invite/zt-csobk21g-2AQRi~X9Uu6PLMuUZdvfjA)
 
91
 
92
  <a href="https://github.com/Kornia/kornia/graphs/contributors">
93
+ <img src="https://contrib.rocks/image?repo=Kornia/kornia" width="60%" />
94
  </a>
95
 
96
  Made with [contrib.rocks](https://contrib.rocks).
97
 
98
+ ## License
99
+
100
+ Kornia is released under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for more information.
101
+