-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #32 from worldcoin/dev
`v1.1.0`
- Loading branch information
Showing
101 changed files
with
1,839 additions
and
426 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,13 +9,15 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div | |
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our community include: | ||
|
||
- Demonstrating empathy and kindness toward other people | ||
- Being respectful of differing opinions, viewpoints, and experiences | ||
- Giving and gracefully accepting constructive feedback | ||
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience | ||
- Focusing on what is best not just for us as individuals, but for the overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
- The use of sexualized language or imagery, and sexual attention or advances of any kind | ||
- Trolling, insulting or derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
|
@@ -24,8 +26,9 @@ Examples of unacceptable behavior include: | |
- Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
The Worldcoin open source community is united in its conviction that its open source materials not be used: | ||
- for mass surveillance of individuals or for unlawful individual surveillance or other unlawful targeted actions, including on the basis on race, gender, sexual orientation, or religion; or | ||
- in any activity or manner that violates, or supports, assists, facilitates, enables, constitutes or is otherwise deemed to be a violation of the Universal Declaration of Human Rights (https://www.un.org/en/universaldeclaration-human-rights/), the International Covenant on Civil and Political Rights (https://www.ohchr.org/en/professionalinterest/pages/ccpr.aspx), and the International Labor Organization Declaration on Fundamental Principles and Rights at Work (https://www.ilo.org/declaration/thedeclaration/textdeclaration/lang--en/index.htm), or any local laws implementing those instruments. | ||
|
||
- For mass surveillance of individuals or for unlawful individual surveillance or other unlawful targeted actions, including on the basis on race, gender, sexual orientation, or religion; or | ||
- In any activity or manner that violates, or supports, assists, facilitates, enables, constitutes or is otherwise deemed to be a violation of the Universal Declaration of Human Rights (https://www.un.org/en/universaldeclaration-human-rights/), the International Covenant on Civil and Political Rights (https://www.ohchr.org/en/professionalinterest/pages/ccpr.aspx), the International Labor Organization Declaration on Fundamental Principles and Rights at Work (https://www.ilo.org/declaration/thedeclaration/textdeclaration/lang--en/index.htm), or any local laws implementing those instruments. | ||
|
||
## Enforcement Responsibilities | ||
|
||
|
@@ -35,17 +38,18 @@ Community leaders have the right and responsibility to remove, edit, or reject c | |
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. | ||
This Code of Conduct also applies to actions taken outside of these spaces, and which have a negative impact on community health. | ||
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. | ||
|
||
This Code of Conduct also applies outside the project spaces when there is a reasonable belief that an individual's behavior may have a negative impact on the project or its community. | ||
|
||
## Enforcement | ||
|
||
We encourage all communities to resolve issues on their own whenever possible. Instances of abusive, harassing, or otherwise unacceptable behavior should be reported to the community leaders responsible for enforcement in a given project or to [email protected]. All project and community leaders are obligated to respect the privacy and security of the reporter of any incident. | ||
|
||
## Attribution | ||
This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. | ||
|
||
Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder. | ||
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
Expanding scope to include external impact on community health inspired by Microsoft’s Open Source Code of Conduct. | ||
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations. | ||
Expanding scope to include impact on community health inspired by Meta's Open Source Code of Conduct. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ ______________________________________________________________________ | |
<div align="center"> | ||
|
||
<p align="center"> | ||
<a href="https://worldcoin.org/"><img src="https://github.com/worldcoin/open-iris/blob/main/docs/source/images/logos/wld.png" width=150px></img></a> | ||
<a href="https://worldcoin.org/"><img src="https://github.com/worldcoin/open-iris/blob/main/docs/source/images/logos/wld.png?raw=true" width=150px></img></a> | ||
</p> | ||
|
||
# **_IRIS: Iris Recognition Inference System_** | ||
|
@@ -31,10 +31,12 @@ ______________________________________________________________________ | |
- [Installation](#installation) | ||
- [Setup for development](#setup-for-development) | ||
- [Running inference](#Running-inference) | ||
- [Disclaimer](#disclaimer) | ||
- [Project structure](#project-structure) | ||
- [Example notebooks](#example-notebooks) | ||
- [Documentation](#documentation) | ||
- [Issues, pull requests and feature requests](#issues-pull-requests-and-feature-requests) | ||
- [Citation](#citation) | ||
- [License](#license) | ||
- [Resources](#resources) | ||
|
||
|
@@ -72,14 +74,14 @@ _The Iris Recognition Inference System (IRIS) software repository is owned and m | |
### Installation | ||
|
||
Installation is as simple as running `pip install` with specifying `IRIS_ENV` installation global flag (`IRIS_ENV` flag may be skipped if `iris` is installed from PyPl server but this option is only available when `iris` is installed on local machine). The `IRIS_ENV` flag is used to indicate an "environment" in which package is meant to work. Possible options are: | ||
1. `SERVER` - For installing `iris` package with dependecies required for running an inference on a local machines. | ||
1. `SERVER` - For installing `iris` package with dependencies required for running an inference on a local machines. | ||
```bash | ||
# On a local machine | ||
pip install open-iris | ||
# or directly from GitHub | ||
IRIS_ENV=SERVER pip install git+https://github.com/worldcoin/open-iris.git | ||
``` | ||
2. `ORB` - For installing `iris` package with dependecies required for running an inference on the Orb. | ||
2. `ORB` - For installing `iris` package with dependencies required for running an inference on the Orb. | ||
```bash | ||
# On the Orb | ||
IRIS_ENV=ORB pip install git+https://github.com/worldcoin/open-iris.git | ||
|
@@ -148,25 +150,42 @@ The `iris` package features a structured design with modular components, enhanci | |
| [`iris.nodes`](https://worldcoin.github.io/open-iris/) | a module that contains implementation of iris recognition pipeline nodes | | ||
| [`iris.orchestration`](https://worldcoin.github.io/open-iris/) | a module that contains iris recognition pipeline's orchestration support mechanisms | | ||
| [`iris.pipelines`](https://worldcoin.github.io/open-iris/) | a module that contains implementation of iris recognition pipelines | | ||
| [`iris.utils`](https://worldcoin.github.io/open-iris/) | a module that contains utilities used throughout the code base and modules usefull for outputs analysis | | ||
| [`iris.utils`](https://worldcoin.github.io/open-iris/) | a module that contains utilities used throughout the code base and modules useful for outputs analysis | | ||
|
||
## Example notebooks | ||
|
||
The Jupyter Notebooks provided present practical guides and real-world instances to demonstrate the complete capabilities of the `iris` package. | ||
|
||
1. **Getting started** [![Open In Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/worldcoin/open-iris/blob/main/colab/GettingStarted.ipynb) | ||
2. **Configuring custom pipeline** [![Open In Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/worldcoin/open-iris/blob/main/colab/ConfiguringCustomPipeline.ipynb) | ||
3. **Matching entities** [![Open In Collab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/worldcoin/open-iris/blob/main/colab/MatchingEntities.ipynb) | ||
|
||
## Documentation | ||
|
||
For detailed documentation, including installation instructions, usage guidelines, and configuration options, please refer to the IRIS project [documentation](https://worldcoin.github.io/open-iris/). | ||
|
||
## Issues, pull requests and feature requests | ||
|
||
If you have any question or you found a bug or you feel like some feature is missing, please don't hesitate to file a new issue, discussion or PR with respective title and description. | ||
If you have any question or you found a bug or you feel like some feature is missing, please don't hesitate to file a new [issue](https://github.com/worldcoin/open-iris/issues), discussion or [PR](https://github.com/worldcoin/open-iris/pulls) with respective title and description. | ||
Any suggestion for potential project improvements are and will always be welcome! | ||
|
||
Feel free to reach out to any project [contributor](https://github.com/worldcoin/open-iris/graphs/contributors)! | ||
## Contact | ||
|
||
If you have any questions, suggestions, or feedback, feel free to reach out to us: | ||
|
||
- Email: [[email protected]](mailto:[email protected]) | ||
- GitHub Issues: [Open an issue](https://github.com/worldcoin/open-iris/issues) | ||
- Contributors: Feel free to reach out to any project [contributor](https://github.com/worldcoin/open-iris/graphs/contributors) directly! | ||
|
||
## Citation | ||
```BibTeX | ||
@misc{wldiris, | ||
author = {Worldcoin AI}, | ||
title = {IRIS: Iris Recognition Inference System of the Worldcoin project}, | ||
year = {2023}, | ||
url = {https://github.com/worldcoin/open-iris} | ||
} | ||
``` | ||
|
||
## License | ||
|
||
|
Oops, something went wrong.