Merge pull request #114127 from Blackmist/amlignore

denrea · web-flow · commit 5daee4499aae · 2020-05-06T13:59:14.000-07:00
Amlignore/Gitignore info
diff --git a/articles/machine-learning/concept-azure-machine-learning-architecture.md b/articles/machine-learning/concept-azure-machine-learning-architecture.md
@@ -115,7 +115,7 @@ For example run configurations, see [Select and use a compute target to train yo
 When you submit a run, Azure Machine Learning compresses the directory that contains the script as a zip file and sends it to the compute target. The zip file is then extracted, and the script is run there. Azure Machine Learning also stores the zip file as a snapshot as part of the run record. Anyone with access to the workspace can browse a run record and download the snapshot.
 
 > [!NOTE]
-> To prevent unnecessary files from being included in the snapshot, make an ignore file (.gitignore or .amlignore). Place this file in the Snapshot directory and add the filenames to ignore in it. The .amlignore file uses the same [syntax and patterns as the .gitignore file](https://git-scm.com/docs/gitignore). If both files exist, the .amlignore file takes precedence.
+> [!INCLUDE [amlinclude-info](../../includes/machine-learning-amlignore-gitignore.md)]
 
 ### GitHub tracking and integration
 
diff --git a/articles/machine-learning/how-to-create-your-first-pipeline.md b/articles/machine-learning/how-to-create-your-first-pipeline.md
@@ -325,7 +325,7 @@ pipeline1 = Pipeline(workspace=ws, steps=steps)
 
 ### Use a dataset 
 
-Datasets created from Azure Blob storage, Azure Files, Azure Data Lake Storage Gen1,  Azure Data Lake Storage Gen2, Azure SQL Database, and Azure Database for PostgreSQL can be used as input to any pipeline step. You can write output to a [DataTransferStep](https://docs.microsoft.com/python/api/azureml-pipeline-steps/azureml.pipeline.steps.datatransferstep?view=azure-ml-py), [DatabricksStep](https://docs.microsoft.com/python/api/azureml-pipeline-steps/azureml.pipeline.steps.databricks_step.databricksstep?view=azure-ml-py), or if you want to write data to a specific datasore use [PipelineData](https://docs.microsoft.com/python/api/azureml-pipeline-core/azureml.pipeline.core.pipelinedata?view=azure-ml-py). 
+Datasets created from Azure Blob storage, Azure Files, Azure Data Lake Storage Gen1,  Azure Data Lake Storage Gen2, Azure SQL Database, and Azure Database for PostgreSQL can be used as input to any pipeline step. You can write output to a [DataTransferStep](https://docs.microsoft.com/python/api/azureml-pipeline-steps/azureml.pipeline.steps.datatransferstep?view=azure-ml-py), [DatabricksStep](https://docs.microsoft.com/python/api/azureml-pipeline-steps/azureml.pipeline.steps.databricks_step.databricksstep?view=azure-ml-py), or if you want to write data to a specific datastore use [PipelineData](https://docs.microsoft.com/python/api/azureml-pipeline-core/azureml.pipeline.core.pipelinedata?view=azure-ml-py). 
 
 > [!IMPORTANT]
 > Writing output data back to a datastore using PipelineData is only supported for Azure Blob and Azure File share datastores. This functionality is not supported for [ADLS Gen 2 datastores](https://docs.microsoft.com/python/api/azureml-core/azureml.data.azure_data_lake_datastore.azuredatalakegen2datastore?view=azure-ml-py) at this time.
@@ -365,7 +365,7 @@ For more detail, including alternate ways to pass and access data, see [Moving d
 When you submit the pipeline, Azure Machine Learning checks the dependencies for each step and uploads a snapshot of the source directory you specified. If no source directory is specified, the current local directory is uploaded. The snapshot is also stored as part of the experiment in your workspace.
 
 > [!IMPORTANT]
-> To prevent files from being included in the snapshot, create a [.gitignore](https://git-scm.com/docs/gitignore) or `.amlignore` file in the directory and add the files to it. The `.amlignore` file uses the same syntax and patterns as the [.gitignore](https://git-scm.com/docs/gitignore) file. If both files exist, the `.amlignore` file takes precedence.
+> [!INCLUDE [amlinclude-info](../../includes/machine-learning-amlignore-gitignore.md)]
 >
 > For more information, see [Snapshots](concept-azure-machine-learning-architecture.md#snapshots).
 
diff --git a/articles/machine-learning/how-to-save-write-experiment-files.md b/articles/machine-learning/how-to-save-write-experiment-files.md
@@ -49,7 +49,7 @@ To resolve this error, store your experiment files on a datastore. If you can't
 Experiment&nbsp;description|Storage limit solution
 ---|---
 Less than 2000 files & can't use a datastore| Override snapshot size limit with <br> `azureml._restclient.snapshots_client.SNAPSHOT_MAX_SIZE_BYTES = 'insert_desired_size'`<br> This may take several minutes depending on the number and size of files.
-Must use specific script directory| Make a `.amlignore` file to exclude files from your experiment snapshot that are not part of the source code. Add the filenames to the `.amlignore` file and place it in the same directory as your training script. The `.amlignore` file uses the same [syntax and patterns](https://git-scm.com/docs/gitignore) as a `.gitignore` file.
+Must use specific script directory| [!INCLUDE [amlinclude-info](../../includes/machine-learning-amlignore-gitignore.md)]
 Pipeline|Use a different subdirectory for each step
 Jupyter notebooks| Create a `.amlignore` file or move your notebook into a new, empty, subdirectory and run your code again.
 
diff --git a/articles/machine-learning/how-to-set-up-training-targets.md b/articles/machine-learning/how-to-set-up-training-targets.md
@@ -360,7 +360,7 @@ After you create a run configuration, you use it to run your experiment.  The co
 > [!IMPORTANT]
 > When you submit the training run, a snapshot of the directory that contains your training scripts is created and sent to the compute target. It is also stored as part of the experiment in your workspace. If you change files and submit the run again, only the changed files will be uploaded.
 >
-> To prevent files from being included in the snapshot, create a [.gitignore](https://git-scm.com/docs/gitignore) or `.amlignore` file in the directory and add the files to it. The `.amlignore` file uses the same syntax and patterns as the [.gitignore](https://git-scm.com/docs/gitignore) file. If both files exist, the `.amlignore` file takes precedence.
+> [!INCLUDE [amlinclude-info](../../includes/machine-learning-amlignore-gitignore.md)]
 > 
 > For more information, see [Snapshots](concept-azure-machine-learning-architecture.md#snapshots).
 
diff --git a/includes/machine-learning-amlignore-gitignore.md b/includes/machine-learning-amlignore-gitignore.md
@@ -0,0 +1,9 @@
+---
+author: blackmist
+ms.service: machine-learning
+ms.topic: include
+ms.date: 05/06/2020
+ms.author: larryfr
+---
+
+To prevent unnecessary files from being included in the snapshot, make an ignore file (`.gitignore` or `.amlignore`) in the directory. Add the files and directories to exclude to this file. For more information on the syntax to use inside this file, see [syntax and patterns](https://git-scm.com/docs/gitignore) for `.gitignore`. The `.amlignore` file uses the same syntax. _If both files exist, the `.amlignore` file takes precedence._

Original file line number	Diff line number	Diff line change
`@@ -360,7 +360,7 @@ After you create a run configuration, you use it to run your experiment. The co`
`360`	`360`	`> [!IMPORTANT]`
`361`	`361`	`> When you submit the training run, a snapshot of the directory that contains your training scripts is created and sent to the compute target. It is also stored as part of the experiment in your workspace. If you change files and submit the run again, only the changed files will be uploaded.`
`362`	`362`	`>`
`363`		-> To prevent files from being included in the snapshot, create a [.gitignore](https://git-scm.com/docs/gitignore) or `.amlignore` file in the directory and add the files to it. The `.amlignore` file uses the same syntax and patterns as the [.gitignore](https://git-scm.com/docs/gitignore) file. If both files exist, the `.amlignore` file takes precedence.
	`363`	`+> [!INCLUDE [amlinclude-info](../../includes/machine-learning-amlignore-gitignore.md)]`
`364`	`364`	`>`
`365`	`365`	`> For more information, see [Snapshots](concept-azure-machine-learning-architecture.md#snapshots).`
`366`	`366`