merge master to temp/docs for updating the documentation

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.vsts-ci.yml

@@ -6,6 +6,8 @@ phases:
     name: Windows
     buildScript: build.cmd
     buildMatrix:
+      Py37:
+        _configuration: RlsWinPy3.7
       Py36:
         _configuration: RlsWinPy3.6
       Py35:
@@ -21,12 +23,8 @@ phases:
     name: Mac
     buildScript: ./build.sh
     buildMatrix:
-      Py36:
-        _configuration: RlsMacPy3.6
-      Py35:
-        _configuration: RlsMacPy3.5
-      Py27:
-        _configuration: RlsMacPy2.7
+      Py37:
+        _configuration: RlsMacPy3.7
     buildQueue:
       name: Hosted macOS
 
@@ -38,27 +36,10 @@ phases:
     buildScript: ./build.sh
     testDistro: ubuntu16
     buildMatrix:
+      Py37:
+        _configuration: RlsLinPy3.7
       Py36:
         _configuration: RlsLinPy3.6
-      Py35:
-        _configuration: RlsLinPy3.5
-      Py27:
-        _configuration: RlsLinPy2.7
-    buildQueue:
-      name: Hosted Ubuntu 1604
-  # Run tests on Ubuntu14
-- template: /build/ci/phase-template.yml
-  parameters:
-    name: Linux_Ubuntu14
-    buildScript: ./build.sh
-    testDistro: ubuntu14
-    buildMatrix:
-      Py36:
-        _configuration: RlsLinPy3.6
-      Py35:
-        _configuration: RlsLinPy3.5
-      Py27:
-        _configuration: RlsLinPy2.7
     buildQueue:
       name: Hosted Ubuntu 1604
   # Run tests on CentOS7
@@ -68,10 +49,6 @@ phases:
     buildScript: ./build.sh
     testDistro: centos7
     buildMatrix:
-      Py36:
-        _configuration: RlsLinPy3.6
-      Py35:
-        _configuration: RlsLinPy3.5
       Py27:
         _configuration: RlsLinPy2.7
     buildQueue:

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# 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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 opensource@microsoft.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

docs/project-docs/contributing.md → CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Welcome!
 
-If you are here, it means you are interested in helping us out. A hearty welcome and thank you! There are many ways you can contribute to the NimbusML project:
+If you are here, it means you are interested in helping us out. A hearty welcome and thank you! While this is an experimental project, we will make our best effort to respond to feedback and issues. If you would like to join the effort, here are ways you can contribute to the NimbusML project:
 
 * Offer PRs to fix bugs or implement new features.
 * Give us feedback and bug reports regarding the software or the documentation.
@@ -24,8 +24,8 @@ All commits in a pull request will be squashed to a single commit with the origi
 
 ## Style Guide
 
-See the [Style Guide](style-guide.md) for information about coding styles, source structure, making pull requests, and more.
+See the [Style Guide](docs/project-docs/style-guide.md) for information about coding styles, source structure, making pull requests, and more.
 
 ## Building and Devleopment
 
-See the [Developer Guide](../developers/developer-guide.md) for details about building from source and developing in this repo.
+See the [Developer Guide](docs/developers/developer-guide.md) for details about building from source and developing in this repo.

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+We are excited to review your PR.
+
+So we can do the best job, please check:
+
+- [ ] There's a descriptive title that will make sense to other developers some time from now. 
+- [ ] There's associated issues. All PR's should have issue(s) associated - unless a trivial self-evident change such as fixing a typo. You can use the format `Fixes #nnnn` in your description to cause GitHub to automatically close the issue(s) when your PR is merged.
+- [ ] Your change description explains what the change does, why you chose your approach, and anything else that reviewers should know.
+- [ ] You have included any necessary tests in the same PR.

README.md

@@ -4,50 +4,73 @@
 
 ML.NET was originally developed in Microsoft Research and is used across many product groups in Microsoft like Windows, Bing, PowerPoint, Excel and others. `nimbusml` was built to enable data science teams that are more familiar with Python to take advantage of ML.NET's functionality and performance. 
 
-This package enables training ML.NET pipelines or integrating ML.NET components directly into Scikit-Learn pipelines (it supports  `numpy.ndarray`, `scipy.sparse_cst`, and `pandas.DataFrame` as inputs).
+This package enables training ML.NET pipelines or integrating ML.NET components directly into [scikit-learn](https://scikit-learn.org/stable/) pipelines (it supports  `numpy.ndarray`, `scipy.sparse_cst`, and `pandas.DataFrame` as inputs).
 
-Documentation can be found [here](https://docs.microsoft.com/en-us/NimbusML/overview) with additional [notebook samples](https://github.com/Microsoft/NimbusML-Samples).
+Documentation can be found [here](https://docs.microsoft.com/en-us/NimbusML/overview) and additional notebook samples can be found [here](https://github.com/Microsoft/NimbusML-Samples).
 
 ## Installation
 
-`nimbusml` runs on Windows, Linux, and macOS - any platform where 64 bit .NET Core is available. It relies on .NET Core, and this is installed automatically as part of the package.
+`nimbusml` runs on Windows, Linux, and macOS. 
 
-`nimbusml` requires Python **2.7**, **3.5**, or **3.6**, 64 bit version only. Python 3.7 is not yet supported.
+`nimbusml` requires Python **2.7**, **3.5**, **3.6** 64 bit version only.
 
 Install `nimbusml` using `pip` with:
 
 ```
 pip install nimbusml
 ```
 
-`nimbusml` has been tested on Windows 10, MacOS 10.13, Ubuntu 14.04, Ubuntu 16.04, Ubuntu 18.04, CentOS 7, and RHEL 7.
+`nimbusml` has been reported to work on Windows 10, MacOS 10.13, Ubuntu 14.04, Ubuntu 16.04, Ubuntu 18.04, CentOS 7, and RHEL 7.
 
 ## Examples
 
 Here is an example of how to train a model to predict sentiment from text samples (based on [this](https://github.com/dotnet/machinelearning/blob/master/README.md) ML.NET example). The full code for this example is [here](https://github.com/Microsoft/NimbusML-Samples/blob/master/samples/2.1%20%5BText%5D%20Sentiment%20Analysis%201%20-%20Data%20Loading%20with%20Pandas.ipynb).
 
 ```python
+from nimbusml import Pipeline, FileDataStream
+from nimbusml.datasets import get_dataset
+from nimbusml.ensemble import FastTreesBinaryClassifier
+from nimbusml.feature_extraction.text import NGramFeaturizer
+
+train_file = get_dataset('gen_twittertrain').as_filepath()
+test_file = get_dataset('gen_twittertest').as_filepath()
+
+train_data = FileDataStream.read_csv(train_file, sep='\t')
+test_data = FileDataStream.read_csv(test_file, sep='\t')
+
 pipeline = Pipeline([ # nimbusml pipeline
-    NGramFeaturizer(columns={'Features': ['SentimentText']}),
-    FastTreeBinaryClassifier(feature=['Features'], label='Sentiment')
+    NGramFeaturizer(columns={'Features': ['Text']}),
+    FastTreesBinaryClassifier(feature=['Features'], label='Label')
 ])
 
 # fit and predict
-pipeline.fit(data)
-results = pipeline.predict(data)
+pipeline.fit(train_data)
+results = pipeline.predict(test_data)
 ```
 
-Instead of creating an `nimbusml` pipeline, you can also integrate components into Scikit-Learn pipelines:
+Instead of creating an `nimbusml` pipeline, you can also integrate components into scikit-learn pipelines:
 
 ```python
+from sklearn.pipeline import Pipeline
+from nimbusml.datasets import get_dataset
+from nimbusml.ensemble import FastTreesBinaryClassifier
+from sklearn.feature_extraction.text import TfidfVectorizer
+import pandas as pd
+
+train_file = get_dataset('gen_twittertrain').as_filepath()
+test_file = get_dataset('gen_twittertest').as_filepath()
+
+train_data = pd.read_csv(train_file, sep='\t')
+test_data = pd.read_csv(test_file, sep='\t')
+
 pipeline = Pipeline([ # sklearn pipeline
     ('tfidf', TfidfVectorizer()), # sklearn transform
-    ('clf', FastTreeBinaryClassifier())]) # nimbusml learner
+    ('clf', FastTreesBinaryClassifier()) # nimbusml learner
 ])
 
 # fit and predict
-pipeline.fit(data)
-results = pipeline.predict(data)
+pipeline.fit(train_data["Text"], train_data["Label"])
+results = pipeline.predict(test_data["Text"])
 ```
 
 
@@ -57,11 +80,15 @@ Many additional examples and tutorials can be found in the [documentation](https
 
 ## Building
 
-To build `nimbusml` from source please visit our [developers guide](docs/developers/developer-guide.md).
+To build `nimbusml` from source please visit our [developer guide](docs/developers/developer-guide.md).
 
 ## Contributing
 
-We welcome [contributions](docs/project-docs/contributing.md)!
+The contributions guide can be found [here](CONTRIBUTING.md). Given the experimental nature of this project, support will be provided on a best-effort basis. We suggest opening an issue for discussion before starting a PR with big changes.
+
+## Support
+
+If you have an idea for a new feature or encounter a problem, please open an [issue](https://github.com/Microsoft/NimbusML/issues/new) in this repository or ask your question on Stack Overflow.
 
 ## License
 

THIRD-PARTY-NOTICES.txt

@@ -0,0 +1,62 @@
+NimbusML uses third-party libraries or other resources that may be
+distributed under licenses different than the NimbusML software.
+
+In the event that we accidentally failed to list a required notice, please
+bring it to our attention. Post an issue or email us:
+
+           nimbusml@microsoft.com
+
+The attached notices are provided for information only.
+
+License notice for ML.NET
+-------------------------
+
+https://github.com/dotnet/machinelearning
+
+
+MIT License
+
+Copyright (c) 2018 .NET Foundation
+
+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.
+
+License notice for .NET Core CLR
+--------------------------------
+
+MIT License
+
+Copyright (c) 2018 .NET Foundation
+
+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.