From 59ad8d193f0eeadc11a632ea171bd60369326b5c Mon Sep 17 00:00:00 2001 From: Fred Park Date: Tue, 29 Aug 2017 08:04:30 -0700 Subject: [PATCH] Update docs --- CODE_OF_CONDUCT.md | 8 ++++++++ CONTRIBUTING.md | 10 +--------- README.md | 16 ++++++---------- docs/02-batch-shipyard-quickstart.md | 4 ++-- docs/14-batch-shipyard-configuration-jobs.md | 6 ++++-- docs/35-batch-shipyard-task-factory.md | 9 +++++---- docs/60-batch-shipyard-site-extension.md | 3 +-- 7 files changed, 27 insertions(+), 29 deletions(-) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fa8fa7b --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,8 @@ +# Code of Conduct + +This project has adopted the +[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the +[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) +or contact [](mailto:opencode@microsoft.com) with any +additional questions or comments. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f49a85..fc0b8de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,4 @@ -Contributing Code ------------------ - -This project has adopted the -[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information see the -[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) -or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any -additional questions or comments. +# Contributing If you would like to contribute to this project, please view the [Microsoft Contribution guidelines](https://azure.github.io/guidelines/). diff --git a/README.md b/README.md index e27fd7a..2d5beaa 100644 --- a/README.md +++ b/README.md @@ -62,15 +62,15 @@ generators allowing complex processing pipelines and DAGs with Docker containers * Transparent support for [GPU-accelerated Docker applications](https://github.com/NVIDIA/nvidia-docker) -on [Azure N-Series VM instances](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes-gpu) +on [Azure N-Series VM instances](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes-gpu) * Support for multi-instance tasks to accommodate Dockerized MPI and multi-node cluster applications on compute pools with automatic job completion and Docker task termination * Transparent assist for running Docker containers utilizing Infiniband/RDMA for MPI on HPC low-latency Azure VM instances: - * [A-Series](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/a8-a9-a10-a11-specs): STANDARD\_A8, STANDARD\_A9 - * [H-Series](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/a8-a9-a10-a11-specs): STANDARD\_H16R, STANDARD\_H16MR - * [N-Series](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes-gpu): STANDARD\_NC24R + * [A-Series](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes-hpc): STANDARD\_A8, STANDARD\_A9 + * [H-Series](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes-hpc): STANDARD\_H16R, STANDARD\_H16MR + * [N-Series](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes-gpu): STANDARD\_NC24R * Support for job schedules and recurrences for automatic execution of tasks at set intervals * Support for live job and job schedule migration between pools @@ -115,9 +115,5 @@ See the [CHANGELOG.md](https://github.com/Azure/batch-shipyard/blob/master/CHANG file. * * * -This project has adopted the -[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). -For more information see the -[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any -additional questions or comments. +Please see this project's [Code of Conduct](CODE_OF_CONDUCT.md) and +[Contributing](CONTRIBUTING.md) guidelines. diff --git a/docs/02-batch-shipyard-quickstart.md b/docs/02-batch-shipyard-quickstart.md index 491515a..a72cb98 100644 --- a/docs/02-batch-shipyard-quickstart.md +++ b/docs/02-batch-shipyard-quickstart.md @@ -4,8 +4,8 @@ and want to jump in without having to install anything, you can utilize the [Deep Learning Jupyter Notebooks](../contrib/notebooks/deep_learning) on [Azure Notebooks](https://notebooks.azure.com/) to quickly get started. -If you would like to use jump in and use Batch Shipyard from the command line, -this doc will provide step-by-step instructions. Although Batch Shipyard +If you would like to use Batch Shipyard from the command line, this quickstart +doc will provide step-by-step instructions. Although Batch Shipyard supports various types of workloads, for the following quickstart example, we will select from the following Deep Learning recipes to quickly get started: * [CNTK-CPU-OpenMPI](../recipes/CNTK-CPU-OpenMPI) diff --git a/docs/14-batch-shipyard-configuration-jobs.md b/docs/14-batch-shipyard-configuration-jobs.md index f89c4e1..25c6733 100644 --- a/docs/14-batch-shipyard-configuration-jobs.md +++ b/docs/14-batch-shipyard-configuration-jobs.md @@ -748,8 +748,10 @@ transferred again. This object currently supports `azure_batch` and This property may be null. Note that if you are using a `task_factory` for the specification, then task factory arguments are applied to the `command`. Therefore, Python-style string formatting options (excluding - keyword formatting) are required for `parametric_sweep` task factories: - either `{}` positional or `{0}` numbering style formatters. Please see the + keyword formatting) are required for certain task factories that generate + parameters to modify the `command`: `{}` positional, `{0}` numbering + style, or `{keyword}` keyword style formatters are required depending + upon the `task_factory` used. Please see the [Task Factory Guide](35-batch-shipyard-task-factory.md) for more information. diff --git a/docs/35-batch-shipyard-task-factory.md b/docs/35-batch-shipyard-task-factory.md index a17c325..b59cd39 100644 --- a/docs/35-batch-shipyard-task-factory.md +++ b/docs/35-batch-shipyard-task-factory.md @@ -1,7 +1,8 @@ # Batch Shipyard and Task Factories The focus of this article is to describe the task factory concept and how it can be utilized to generate arbitrary task arrays. This is particularly useful -in creating parameter (parametric) sweeps or repeated tasks. +in creating parameter (parametric) sweeps, replicated/repeated tasks, or +assigning generated parameters for tasks. # Task Factory The normal configuration structure for a job in Batch Shipyard is through the @@ -399,8 +400,8 @@ behavior or even potentially unstable execution of the submission process. ## Custom A `custom` task factory will generate tasks by calling a custom Python-based -`generate` generator function supplied by the user. This is accomplished by -importing a user-defined Python module which has a defined `generate` +generator function named `generate` supplied by the user. This is accomplished +by importing a user-defined Python module which has a defined `generate` generator function. For example, suppose we create a directory named `foo` in our Batch Shipyard @@ -479,7 +480,7 @@ Of course, this example is contrived and custom task factory logic will invariably be more complex. Your generator function can be dependent upon any Python package that is needed to accomodate complex task factory parameter generation scenarios. Please note that if you have installed your Batch -Shipyard enviornment into a virtual environment and your dependencies are +Shipyard environment into a virtual environment and your dependencies are non-local (i.e., not in the Batch Shipyard directory), then you need to ensure that your dependencies are properly installed in the correct environment. diff --git a/docs/60-batch-shipyard-site-extension.md b/docs/60-batch-shipyard-site-extension.md index 3a666e0..b97845d 100644 --- a/docs/60-batch-shipyard-site-extension.md +++ b/docs/60-batch-shipyard-site-extension.md @@ -41,8 +41,7 @@ official nuget feed for Azure App Site Extensions. ![60-site-extension-step2-2.png](https://azurebatchshipyard.blob.core.windows.net/github/60-site-extension-step2-2.png) You should select the latest version of Python 3.X x64 that is available. -At the time of this writing, Python 3.6.1 x64 was the latest available. Click -the `+` icon to install this site extension to your Azure Function App +Click the `+` icon to install this site extension to your Azure Function App environment. ![60-site-extension-step2-3.png](https://azurebatchshipyard.blob.core.windows.net/github/60-site-extension-step2-3.png)