initial commit

.github/ISSUE_TEMPLATE/bug_report_template.md

@@ -0,0 +1,68 @@
+---
+name: Bug Report
+about: Use this template for reporting bugs encountered while using FiftyOne.
+labels: "bug"
+title: "[BUG]"
+---
+
+### Instructions
+
+Thank you for submitting an issue. Please refer to our
+[issue policy](https://www.github.com/voxel51/fiftyone/blob/develop/ISSUE_POLICY.md)
+for information on what types of issues we address.
+
+**Please fill in this template to ensure a timely and thorough response.**
+
+-   Place an "x" between the brackets next to an option if it applies. Example:
+    -   [x] Selected option
+-   Please delete this section (all content above this line) before submitting
+    the issue
+
+### System information
+
+-   **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**:
+-   **FiftyOne installed from (pip or source)**:
+-   **FiftyOne version (run `fiftyone --version`)**:
+-   **Python version**:
+
+### Commands to reproduce
+
+As thoroughly as possible, please provide the Python and/or shell commands used
+to encounter the issue. Application steps can be described in the next section.
+
+```
+# commands here
+```
+
+### Describe the problem
+
+Describe the problem clearly here. Include descriptions of the expected
+behavior and the actual behavior.
+
+### Code to reproduce issue
+
+Provide a reproducible test case that is the bare minimum necessary to generate
+the problem.
+
+### Other info / logs
+
+Include any logs or source code that would be helpful to diagnose the problem.
+If including tracebacks, please include the full traceback. Large logs and
+files should be attached.
+
+### What areas of FiftyOne does this bug affect?
+
+-   [ ] `App`: FiftyOne application issue
+-   [ ] `Core`: Core `fiftyone` Python library issue
+-   [ ] `Server`: Fiftyone server issue
+
+### Willingness to contribute
+
+The FiftyOne Community encourages bug fix contributions. Would you or another
+member of your organization be willing to contribute a fix for this bug to the
+FiftyOne codebase?
+
+-   [ ] Yes. I can contribute a fix for this bug independently.
+-   [ ] Yes. I would be willing to contribute a fix for this bug with guidance
+        from the FiftyOne community.
+-   [ ] No. I cannot contribute a bug fix at this time.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/documentation_issue_template.md

@@ -0,0 +1,38 @@
+---
+name: Documentation Issue
+about: Use this template for proposing documentation issues.
+labels: "documentation"
+title: "[DOCUMENTATION]"
+---
+
+### Instructions
+
+Thank you for submitting an issue. Please refer to our
+[issue policy](https://www.github.com/voxel51/fiftyone/blob/develop/ISSUE_POLICY.md)
+for information on what types of issues we address.
+
+**Please fill in this template to ensure a timely and thorough response.**
+
+-   Place an "x" between the brackets next to an option if it applies. Example:
+    -   [x] Selected option
+-   Please delete this section (all content above this line) before submitting
+    the issue
+
+### URL(s) with the issue:
+
+Please provide a link to the documentation entry in question.
+
+### Description of proposal (what needs changing):
+
+Provide a clear description. Why is the proposed documentation better?
+
+### Willingness to contribute
+
+The FiftyOne Community encourages documentation contributions. Would you or
+another member of your organization be willing to contribute a fix for this
+documentation issue to the FiftyOne codebase?
+
+-   [ ] Yes. I can contribute a documentation fix independently.
+-   [ ] Yes. I would be willing to contribute a document fix with guidance from
+        the FiftyOne community.
+-   [ ] No. I cannot contribute a documentation fix at this time.

.github/ISSUE_TEMPLATE/feature_request_template.md

@@ -0,0 +1,56 @@
+---
+name: Feature Request
+about: Use this template for feature and enhancement proposals.
+labels: "enhancement"
+title: "[FR]"
+---
+
+### Instructions
+
+Thank you for submitting an issue. Please refer to our
+[issue policy](https://www.github.com/voxel51/fiftyone/blob/develop/ISSUE_POLICY.md)
+for information on what types of issues we address.
+
+**Please fill in this template to ensure a timely and thorough response.**
+
+-   Place an "x" between the brackets next to an option if it applies. Example:
+    -   [x] Selected option
+-   Please delete this section (all content above this line) before submitting
+    the issue
+
+### Proposal Summary
+
+(In a few sentences, provide a clear, high-level description of the feature
+request)
+
+### Motivation
+
+-   What is the use case for this feature?
+-   Why is this use case valuable to support for FiftyOne users in general?
+-   Why is this use case valuable to support for your project(s) or
+    organization?
+-   Why is it currently difficult to achieve this use case? (please be as
+    specific as possible about why related FiftyOne features and components are
+    insufficient)
+
+### What areas of FiftyOne does this feature affect?
+
+-   [ ] App: FiftyOne application
+-   [ ] Core: Core `fiftyone` Python library
+-   [ ] Server: FiftyOne server
+
+### Details
+
+(Use this section to include any additional information about the feature. If
+you have a proposal for how to implement this feature, please include it here.)
+
+### Willingness to contribute
+
+The FiftyOne Community encourages new feature contributions. Would you or
+another member of your organization be willing to contribute an implementation
+of this feature?
+
+-   [ ] Yes. I can contribute this feature independently.
+-   [ ] Yes. I would be willing to contribute this feature with guidance from
+        the FiftyOne community.
+-   [ ] No. I cannot contribute this feature at this time.

.github/ISSUE_TEMPLATE/installation_issue_template.md

@@ -0,0 +1,47 @@
+---
+name: Installation Issues
+about:
+    Use this template for reporting bugs encountered while installing FiftyOne.
+labels: "bug"
+title: "[SETUP-BUG]"
+---
+
+### Instructions
+
+Thank you for submitting an issue. Please refer to our
+[issue policy](https://www.github.com/voxel51/fiftyone/blob/develop/ISSUE_POLICY.md)
+for information on what types of issues we address.
+
+**Please fill in this template to ensure a timely and thorough response.**
+
+-   Place an "x" between the brackets next to an option if it applies. Example:
+    -   [x] Selected option
+-   Please delete this section (all content above this line) before submitting
+    the issue
+
+### System information
+
+-   **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**:
+-   **FiftyOne installed from (pip or source)**:
+-   **FiftyOne version (run `fiftyone --version`)**:
+-   **Python version**:
+
+### Commands to reproduce
+
+As thoroughly as possible, please provide the Python and/or shell commands used
+to encounter the issue.
+
+```
+# commands here
+```
+
+### Describe the problem
+
+Provide the exact sequence of commands / steps that you executed before running
+into the problem.
+
+### Other info / logs
+
+Include any logs or source code that would be helpful to diagnose the problem.
+If including tracebacks, please include the full traceback. Large logs and
+files should be attached.

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+## What changes are proposed in this pull request?
+
+(Please fill in changes proposed in this fix)
+
+## How is this patch tested? If it is not, please explain why.
+
+(Details)

.gitignore

@@ -0,0 +1,15 @@
+
+**/*.DS_store
+
+__pycache__
+*.py[cod]
+
+*.egg-info
+.project
+.pydevproject
+**/*.ipynb_checkpoints
+.idea
+
+*~
+
+data/

CONTRIBUTING.md

@@ -0,0 +1,20 @@
+# Contributing to FiftyOne Examples
+
+FiftyOne is open source and community contributions are welcome!
+
+This page provides useful information about contributing to FiftyOne Examples.
+
+## Issues
+
+FiftyOne defines four categories of issues: feature requests, bug reports,
+documentation fixes, and installation issues. Details about each issue type and
+the issue lifecycle are discussed in the
+[FiftyOne Issue Policy](ISSUE_POLICY.md).
+
+## Contribution guidelines
+
+To contribute new examples, documentation, code, etc., please send us a
+pull request.
+
+Most examples are best provided as [Jupyter Notebooks](https://jupyter.org),
+to make it easy for users to download and run them.

ISSUE_POLICY.md

@@ -0,0 +1,105 @@
+# Issue Policy
+
+The FiftyOne Issue Policy outlines the categories of GitHub issues we use and
+discusses the guidelines & processes associated with each type of issue.
+
+Before filing an issue, make sure to
+[search for related issues](https://github.com/voxel51/fiftyone/issues) and
+check if they address yours.
+
+## Issue Categories
+
+Our policy is that GitHub issues fall into one of the following categories:
+
+1. Feature Requests
+2. Bug reports
+3. Documentation fixes
+4. Installation issues
+
+Each category has its own GitHub issue template. Please do not delete the issue
+template unless you are certain your issue is outside its scope.
+
+### Feature Requests
+
+#### Guidelines
+
+Feature requests that are likely to be accepted:
+
+-   Are minimal in scope (note that it's always easier to add additional
+    functionality later than remove functionality)
+-   Are extensible (e.g. if adding an integration with an ML framework, is it
+    possible to add similar integrations with other frameworks?)
+-   Have user impact & value that justifies the maintenance burden of
+    supporting the feature moving forwards. The
+    [JQuery contributor guide](https://contribute.jquery.org/open-source/#contributing-something-new)
+    has an excellent discussion on this.
+
+#### Lifecycle
+
+Feature requests typically go through the following lifecycle:
+
+1. A feature request GitHub Issue is submitted, which contains a high-level
+   description of the proposal and its motivation. We encourage requesters to
+   provide an overview of the feature's implementation as well, if possible.
+2. The [issue is triaged](ISSUE_TRIAGE.md) to identify whether more information
+   is needed from the author, give an indication of priority, and route feature
+   requests to appropriate committers.
+3. The feature request is discussed with a committer. The committer will
+   provide input on the implementation overview or ask for a more detailed
+   design, if applicable.
+4. After discussion & agreement on the feature request and its implementation,
+   an implementation owner is identified.
+5. The implementation owner begins developing the feature and ultimately files
+   associated pull requests against the FiftyOne Repository or packages the
+   feature as an FiftyOne Plugin.
+
+### Bug reports
+
+Bug reports typically go through the following lifecycle:
+
+1. A bug report GitHub Issue is submitted, which contains a high-level
+   description of the bug and information required to reproduce it.
+2. The [bug report is triaged](ISSUE_TRIAGE.md) to identify whether more
+   information is needed from the author, give an indication of priority, and
+   route to request appropriate committers.
+3. An FiftyOne committer reproduces the bug and provides feedback about how to
+   implement a fix.
+4. After an approach has been agreed upon, an owner for the fix is identified.
+   FiftyOne committers may choose to adopt ownership of severe bugs to ensure a
+   timely fix.
+5. The fix owner begins implementing the fix and ultimately files associated
+   pull requests.
+
+### Documentation fixes
+
+Documentation issues typically go through the following lifecycle:
+
+1. A documentation GitHub Issue is submitted, which contains a description of
+   the issue and its location(s) in the FiftyOne documentation.
+2. The [issue is triaged](ISSUE_TRIAGE.md) to identify whether more information
+   is needed from the author, give an indication of priority, and route the
+   request to appropriate committers.
+3. An FiftyOne committer confirms the documentation issue and provides feedback
+   about how to implement a fix.
+4. After an approach has been agreed upon, an owner for the fix is identified.
+   FiftyOne committers may choose to adopt ownership of severe documentation
+   issues to ensure a timely fix.
+5. The fix owner begins implementing the fix and ultimately files associated
+   pull requests.
+
+### Installation issues
+
+Installation issues typically go through the following lifecycle:
+
+1. An installation GitHub Issue is submitted, which contains a description of
+   the issue and the platforms its affects.
+2. The [issue is triaged](ISSUE_TRIAGE.md) to identify whether more information
+   is needed from the author, give an indication of priority, and route the
+   issue to appropriate committers.
+3. An FiftyOne committer confirms the installation issue and provides feedback
+   about how to implement a fix.
+4. After an approach has been agreed upon, an owner for the fix is identified.
+   FiftyOne committers may choose to adopt ownership of severe installation
+   issues to ensure a timely fix.
+5. The fix owner begins implementing the fix and ultimately files associated
+   pull requests.