Rijai reposetup (#2)
* Adding azure-pipelines.yml file to set up the build and a sample yml file to set up conda env on build machine * Update azure-pipelines.yml for Azure Pipelines [skip ci] * Update azure-pipelines.yml for Azure Pipelines [skip ci] * Update azure-pipelines.yml for Azure Pipelines [skip ci] * Update azure-pipelines.yml for Azure Pipelines [skip ci] * Update azure-pipelines.yml for Azure Pipelines [skip ci] * Adding config files to go with pre-commit checks, also added instruction for the same in the CONTRIBUTING.md guide * Modifying readme and adding status badge * Adding few comments to yml file
This commit is contained in:
Richin Jain
GitHub
Родитель
ca7ad2cadf
Коммит
59a5e15709
|
|
@ -23,12 +23,14 @@ steps:
|
|||
conda env create -f environment.yml
|
||||
conda env list
|
||||
source activate nlp
|
||||
displayName: 'Build Configuration'
|
||||
displayName: 'Creating Conda Environment with dependencies'
|
||||
|
||||
- bash: |
|
||||
source activate nlp
|
||||
python -m ipykernel install --user --name nlp --display-name "nlp"
|
||||
# pytest --junitxml=junit/test-unitttest.xml #not running any tests for now
|
||||
# Commenting out pytest since it contains bunch of tests from other project which are not applicable.
|
||||
# But keeping the line here to show how to run it once tests relevant to this project are added
|
||||
# pytest --junitxml=junit/test-unitttest.xml #not running any tests for now
|
||||
displayName: 'Run Unit tests'
|
||||
|
||||
- task: PublishTestResults@2
|
||||
|
|
|
|||
96
README.md
96
README.md
|
|
@ -1,87 +1,13 @@
|
|||
# NLP Best Practices
|
||||
|
||||
This repository will provide examples and best practices for building NLP systems, provided as Jupyter notebooks.
|
||||
|
||||
[](https://dev.azure.com/best-practices/nlp/_build/latest?definitionId=21&branchName=staging)
|
||||
|
||||
## Planning etc documents
|
||||
|
||||
All feature planning is done via projects, milestones, and issues in this Github repository.
|
||||
|
||||
|
||||
# Recipe Template
|
||||
|
||||
|
||||
# Table of Contents
|
||||
- [Goal of Template Project](#goal-of-template-project)
|
||||
- [Required Folders and Files](#required-folders-and-files)
|
||||
- [Strongly Recommended](#strongly-recommended)
|
||||
- [Recommended Folders and Files](#recommended-folders-and-files)
|
||||
- [Files to Help You Create Your Project](#files-to-help-you-create-your-project)
|
||||
- [Microsoft Style Guide](#microsoft-style-guide)
|
||||
- [Future](#future)
|
||||
|
||||
## Goal of Template Project
|
||||
The intent of the Recipe Template is to make it easier to set up subsequent Recipe projects by:
|
||||
- providing common base templates for notebook and other files
|
||||
- simplifying the ability to capture repo metrics consistently across projects
|
||||
- providing a framework for automated testing so that you have less work to do for this effort
|
||||
- enabling easier integration with Azure DevOps CI/CD (more coming)
|
||||
- providing required Microsoft files for OSS
|
||||
- providing recommendations to get your project up and running quickly by leveraging prior work
|
||||
|
||||
|
||||
## Required Folders and Files
|
||||
|
||||
Some files and folders in the Recipe Template are recommendations and some are requirements.
|
||||
These are the required folders that MUST NOT BE RENAMED OR CHANGED:
|
||||
|
||||
|
||||
scripts/repo_metrics - metrics for the github repo which are stored in CosmosDB
|
||||
tests - This folder name is used in automated test scripts and expects the following folders, unit, smoke and integration
|
||||
tests/unit - unit tests are run when a PR is submitted
|
||||
tests/smoke - smoke tests are run nightly
|
||||
tests/integration - check trigger (bz)
|
||||
|
||||
This file is required:
|
||||
|
||||
LICENSE - This required file contains the MIT license and is required by Microsoft for open source projects. Do not edit it.
|
||||
|
||||
## Strongly Recommended
|
||||
These files are strongly recommended to include in your repo:
|
||||
|
||||
configuration.ipynb
|
||||
.gitignore
|
||||
AUTHORS.md
|
||||
CONTRIBUTING.md
|
||||
SETUP.md
|
||||
chglog.txt
|
||||
codeofconduct.md
|
||||
|
||||
## Recommended Folders and Files
|
||||
|
||||
Recommendations are provided for additional folders and files to assist in setting up a new repo. If you feel strongly about one of these names, you can change it or delete. If you believe additional root folders are required, please add an issue to the Recipe Template github.
|
||||
|
||||
These folders are recommendations:
|
||||
|
||||
benchmarks - some repos target different verticals with their benchmarks and create folders in benchmarks for that purpose.
|
||||
docs - Some repos have docs, some do not and store their info in the example notebooks or scripts
|
||||
examples - This stores both notebooks as well as .py or .r files
|
||||
models - Thus far, models have been used by performance related repos.
|
||||
utils_xxx (or xxx_utils) - Naming utils is your preference.
|
||||
|
||||
Although there are recommendations for some folders in the root, you may delete those that you do not need. Again, please do not delete those indicated in [Required Folders and Files](#required-folders-and-files).
|
||||
|
||||
## Files to Help You Create Your Project
|
||||
|
||||
Additional files provide guidance on creating the README, Jupyter Notebook template and insights on AzureML.
|
||||
These are for your use and should NOT be included in your repo:
|
||||
|
||||
ML Notebook Plan.docx - This file contains a thorough description of how to create an effective Jupyter NB and was created by Jamie. Some of the content from the .docx are included in this README.
|
||||
Notebook Template.ipynb - This template is based on the description in the ML Notebook Plan.docx.
|
||||
|
||||
Please review the ML Notebook Plan.docx for details and additional information.
|
||||
|
||||
## Microsoft Style Guide
|
||||
The [Microsoft Style Guide](https://aka.ms/style) has been vetted over the years and contains a wealth of condensed knowledge.
|
||||
We strongly recommend reading it.
|
||||
|
||||
## Future
|
||||
In the future, additional files for DevOps will be added to require less effort to integrate with Github for unit, smoke and integration tests. Improvements are currently underway to improve the integration of DevOps with AzureML and updates will be added as they become available.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Contributing
|
||||
This project welcomes contributions and suggestions. Before contributing, please see our [contribution guidelines](CONTRIBUTING.md).
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче