initial

Author: minerva-ml

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. 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.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+## Contributing to Open Solution for [Google AI Open Images - Object Detection Track](https://www.kaggle.com/c/google-ai-open-images-object-detection-track).
+
+### Get involved
+You are welcome to contribute to this Open Solution. To get started:
+1. Check [our kanban board](https://github.com/neptune-ml/open-solution-googleai-object-detection/projects/1) to see what we are working on right now.
+1. Express your interest in a paticular [issue](https://github.com/neptune-ml/open-solution-googleai-object-detection/issues) by submitting a comment or,
+    * submit your own [issue](https://github.com/neptune-ml/open-solution-googleai-object-detection/issues).
+1. We will get back to you in order to start working together.
+
+### Code contributions
+Major - and most appreciated - contribution is [pull request](https://github.com/neptune-ml/open-solution-googleai-object-detection/pulls) with feature or bug fix.
+
+### Remarks
+In case of custom ideas, please contact core contributors directly at [email protected].
+#
+
+Thanks!
+
+Kuba & Kamil,
+
+*core contributors to the Open Solution*

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 neptune.ml
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+## Pull Request template to the *[Google AI Open Images - Object Detection Track](https://www.kaggle.com/c/google-ai-open-images-object-detection-track)* Open Solution
+
+Major - and most appreciated - contribution is pull request with feature or bug fix. Each pull request initiates discussion about your code contribution.
+
+Each pull request should be provided with minimal description about its contents.
+#
+
+Thanks!
+
+Kuba & Kamil,
+
+_core contributors to the Open Solutions_

README.md

@@ -0,0 +1,77 @@
+# Google AI Open Images - Object Detection Track: Open Solution
+
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://github.com/neptune-ml/open-solution-googleai-object-detection/blob/master/LICENSE)
+[![Join the chat at https://gitter.im/neptune-ml/open-solution-googleai-object-detection](https://badges.gitter.im/neptune-ml/open-solution-googleai-object-detection.svg)](https://gitter.im/neptune-ml/open-solution-googleai-object-detection?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+This is an open solution to the [Google AI Open Images - Object Detection Track](https://www.kaggle.com/c/google-ai-open-images-object-detection-track) :smiley:
+
+## Our goals
+We are building entirely open solution to this competition. Specifically:
+1. **Learning from the process** - updates about new ideas, code and experiments is the best way to learn data science. Our activity is especially useful for people who wants to enter the competition, but lack appropriate experience.
+1. Encourage more Kagglers to start working on this competition.
+1. Deliver open source solution with no strings attached. Code is available on our [GitHub repository :computer:](https://github.com/neptune-ml/open-solution-googleai-object-detection). This solution should establish solid benchmark, as well as provide good base for your custom ideas and experiments. We care about clean code :smiley:
+1. We are opening our experiments as well: everybody can have **live preview** on our experiments, parameters, code, etc. Check: [Google-AI-Object-Detection-Challenge :chart_with_upwards_trend:](https://app.neptune.ml/neptune-ml/Google-AI-Object-Detection-Challenge).
+
+## Dataset for this competition
+This competition is special, because it used [Open Images Dataset V4](https://storage.googleapis.com/openimages/web/index.html), which is quite large: `>1.8M` images and `>0.5TB` :astonished: To make it more approachable, we are hosting entire dataset in the neptune's public directory :sunglasses:. **You can use this dataset in [neptune.ml](https://neptune.ml) with no additional setup :+1:.**
+
+## Learn more about our solutions
+[Kaggle discussion](https://www.kaggle.com/c/google-ai-open-images-object-detection-track/discussion) is our primary way of communication, however, we are also documenting our work on the [Wiki pages :blue_book:](https://github.com/neptune-ml/open-solution-googleai-object-detection/wiki). Click on the dolphin to get started [:dolphin:](https://github.com/neptune-ml/open-solution-googleai-object-detection/wiki).
+
+## Disclaimer
+In this open source solution you will find references to the [neptune.ml](https://neptune.ml). It is free platform for community Users, which we use daily to keep track of our experiments. Please note that using neptune.ml is not necessary to proceed with this solution. You may run it as plain Python script :wink:.
+
+## Installation
+### Fast Track
+1. Clone repository and install requirements (check _requirements.txt_)
+1. Register to the [neptune.ml](https://neptune.ml/login) _(if you wish to use it)_
+1. Run experiment:
+
+:trident:
+```bash
+neptune run will appear here soon :)
+```
+
+:snake:
+```bash
+python command will appear here soon :)
+```
+
+### Step by step
+1. Clone this repository
+```bash
+git clone https://github.com/neptune-ml/open-solution-googleai-object-detection.git
+```
+2. Install requirements in your Python3 environment
+```bash
+pip3 install requirements.txt
+```
+3. Register to the [neptune.ml](https://neptune.ml/login) _(if you wish to use it)_
+4. Update data directories in the [neptune.yaml](https://github.com/neptune-ml/open-solution-googleai-object-detection/blob/master/neptune.yaml) configuration file
+5. Run experiment:
+
+:trident:
+```bash
+neptune login
+neptune run will appear here soon :)
+```
+
+:snake:
+```bash
+python command will appear here soon :)
+```
+
+6. collect submit from `experiment_directory` specified in the [neptune.yaml](https://github.com/neptune-ml/open-solution-googleai-object-detection/blob/master/neptune.yaml)
+
+## Get involved
+You are welcome to contribute your code and ideas to this open solution. To get started:
+1. Check [competition project](https://github.com/neptune-ml/open-solution-googleai-object-detection/projects/1) on GitHub to see what we are working on right now.
+1. Express your interest in paticular task by writing comment in this task, or by creating new one with your fresh idea.
+1. We will get back to you quickly in order to start working together.
+1. Check [CONTRIBUTING](CONTRIBUTING.md) for some more information.
+
+## User support
+There are several ways to seek help:
+1. [Kaggle discussion](https://www.kaggle.com/c/google-ai-open-images-object-detection-track/discussion) is our primary way of communication.
+1. Read project's [Wiki](https://github.com/neptune-ml/open-solution-googleai-object-detection/wiki), where we publish descriptions about the code, pipelines and supporting tools such as [neptune.ml](https://neptune.ml).
+1. Submit an [issue]((https://github.com/neptune-ml/open-solution-googleai-object-detection/issues)) directly in this repo.