edits

Author: v-thepet

articles/machine-learning/concept-train-model-git-integration.md

@@ -9,7 +9,7 @@ ms.topic: conceptual
 author: ositanachi
 ms.author: osiotugo
 ms.reviewer: larryfr
-ms.date: 06/11/2024
+ms.date: 06/12/2024
 ms.custom: sdkv2, build-2023
 ---
 # Git integration for Azure Machine Learning
@@ -18,13 +18,14 @@ ms.custom: sdkv2, build-2023
 
 Azure Machine Learning fully supports Git repositories for tracking work. You can clone repositories directly onto your shared workspace file system, use Git on your local workstation, or use Git from a continuous integration and continuous deployment (CI/CD) pipeline.
 
-When you submit an Azure Machine Learning training job that has source files from a local Git repository, information about the repo is tracked as part of the training job. Because it's tracked from the local Git repo, the Git information isn't tied to any specific central repository. Your repository can be cloned from any Git-compatible service, such as GitHub, GitLab, Bitbucket, or Azure DevOps.
+When you submit an Azure Machine Learning training job that has source files from a local Git repository, information about the repo is tracked as part of the training job. Because the information comes from the local Git repo, it isn't tied to any specific central repository. Your repository can be cloned from any Git-compatible service, such as GitHub, GitLab, Bitbucket, or Azure DevOps.
 
 > [!TIP]
 > You can use Visual Studio Code to interact with Git through a graphical user interface. To connect to an Azure Machine Learning remote compute instance by using Visual Studio Code, see [Launch Visual Studio Code integrated with Azure Machine Learning (preview)](how-to-launch-vs-code-remote.md).
 > 
 > For more information on Visual Studio Code version control features, see [Use Version Control in Visual Studio Code](https://code.visualstudio.com/docs/editor/versioncontrol) and [Work with GitHub in Visual Studio Code](https://code.visualstudio.com/docs/editor/github).
 
+<a name="#clone-git-repositories-into-your-workspace-file-system"></a>
 ## Git repositories in a workspace file system
 
 Azure Machine Learning provides a shared file system for all users in a workspace. The best way to clone a Git repository into this file share is to create a compute instance and [open a terminal](./how-to-access-terminal.md). In the terminal, you have access to a full Git client and can clone and work with Git by using the Git CLI. For more information about the Git CLI, see [Git CLI](https://git-scm.com/docs/gitcli).
@@ -33,90 +34,92 @@ You can clone any Git repository you can authenticate to, such as GitHub, Azure
 
 There are some differences between cloning to the local file system of the compute instance or cloning to the shared file system, mounted as the *~/cloudfiles/code/* directory. In general, cloning to the local file system provides better performance than cloning to the mounted file system. However, if you delete and recreate the compute instance, the local file system is lost, while the mounted shared file system remains.
 
-## Clone Git repositories with SSH
+## Clone a Git repository with SSH
 
-You can clone a repo by using Secure Shell Protocol (SSH). The following sections describe how to clone a repo by using SSH. To use SSH, you need to authenticate your Git account with SSH by using an SSH key.
+You can clone a repo by using Secure Shell (SSH) protocol. The following sections describe how to clone a repo by using SSH. To use SSH, you need to authenticate your Git account with SSH by using an SSH key.
 
 ### Generate and save a new SSH key
 
-To generate a new SSH key:
+In the Azure Machine Learning studio **Notebook** page, open a terminal window and run the following command, substituting your email address.
 
-1. In the Azure Machine Learning studio **Notebook** page, open a terminal window and run the following command, substituting your email address.
-
-   ```bash
-   ssh-keygen -t rsa -b 4096 -C "[email protected]"
-   ```
+```bash
+ssh-keygen -t ed25519 -C "[email protected]"
+```
 
-   The command returns the output `Generating public/private rsa key pair.` and generates a new SSH key with the provided email as a label.
+The command returns the following output:
 
-1. At the following prompt, make sure the location is `/home/azureuser/.ssh`, or specify that location, and then press Enter.
+```bash
+Generating public/private ed25519 key pair.
+Enter file in which to save the key (/home/azureuser/.ssh/id_ed25519):
+```
 
-   ```bash
-    Enter a file in which to save the key (/home/azureuser/.ssh/id_rsa): [Press enter]
-   ```
+Make sure the location in the preceding output is `/home/azureuser/.ssh`, or change it to that location, and then press Enter.
 
-   The key file saves on the compute instance, and is accessible only to the compute instance owner.
+It's best to add a passphrase to your SSH key for added security. At the following prompts, enter a secure passphrase.
 
-1. It's best to add a passphrase to your SSH key for added security. At the following prompt, enter a secure passphrase.
+```bash
+Enter passphrase (empty for no passphrase): 
+Enter same passphrase again: 
+```
 
-   ```bash
-   > Enter passphrase (empty for no passphrase): [Type a passphrase]
-   > Enter same passphrase again: [Type passphrase again]
-   ```
+When you press Enter, the `ssh-keygen` command generates a new SSH key with the provided email address as a label. The key file saves on the compute instance, and is accessible only to the compute instance owner.
 
 ### Add the public key to your Git account
 
-1. In your terminal window, run the following command to copy the contents of your public key file. If you renamed the key, replace `id_rsa.pub` with the public key file name.
+In your terminal window, run the following command to display the contents of your public key file. If you renamed the key, replace `id_ed25519.pub` with the public key file name.
 
-   ```bash
-   cat ~/.ssh/id_rsa.pub
-   ```
+```bash
+cat ~/.ssh/id_ed25519.pub
+```
 
-1. To add the SSH key to your Git account, refer to the following instructions depending on your Git service:
-
-  - [GitHub](https://docs.github.com/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account#adding-a-new-ssh-key-to-your-account)
-  - [GitLab](https://docs.gitlab.com/ee/user/ssh.html#add-an-ssh-key-to-your-gitlab-account)
-  - [Azure DevOps](/azure/devops/repos/git/use-ssh-keys-to-authenticate#step-2-add-the-public-key-to-azure-devops)
-  - [BitBucket](https://support.atlassian.com/bitbucket-cloud/docs/configure-ssh-and-two-step-verification/)
+Copy the output.
 
 > [!TIP]
 > To copy and paste in the terminal window, use these keyboard shortcuts depending on your operating system:
 > 
-> - Windows: Ctrl+Insert to copy, Ctrl+Shift+V or Ctrl+Shift+Insert to paste.
+> - Windows: Ctrl+C or Ctrl+Insert to copy, Ctrl+V or Ctrl+Shift+V to paste.
 > - MacOS: Cmd+C to copy and Cmd+V to paste.
 > 
 > Some browsers might not support clipboard permissions properly.
 
+Add the SSH key to your Git account by using the following instructions, depending on your Git service:
+
+  - [GitHub](https://docs.github.com/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account#adding-a-new-ssh-key-to-your-account)
+  - [GitLab](https://docs.gitlab.com/ee/user/ssh.html#add-an-ssh-key-to-your-gitlab-account)
+  - [Azure DevOps](/azure/devops/repos/git/use-ssh-keys-to-authenticate#step-2-add-the-public-key-to-azure-devops)
+  - [BitBucket](https://support.atlassian.com/bitbucket-cloud/docs/configure-ssh-and-two-step-verification/)
+
 ### Clone the Git repository with SSH
 
-1. Copy the SSH Git clone URL from the Git repo.
+1. Copy the SSH Git clone URL from the Git repo you want to clone.
 
-1. Run the following `git clone` command, using your SSH Git repo URL. For example:
+1. Run the following `git clone` command, using your SSH Git clone URL. For example:
 
    ```bash
    git clone [email protected]:GitUser/azureml-example.git
    ```
 
-Git clones the repo and sets up the origin remote to connect with SSH for future Git commands.
-
-#### Verify fingerprint
+1. SSH might display the server's SSH fingerprint and ask you to verify it, as in the following example.
 
-SSH might display the server's SSH fingerprint and ask you to verify it, as in the following example.
+   ```bash
+   The authenticity of host 'github.com (000.00.000.0)' can't be established.
+   ECDSA key fingerprint is SHA256:0000000000000000000/00000000/00000000.
+   Are you sure you want to continue connecting (yes/no/[fingerprint])?
+   ```
 
-```bash
-The authenticity of host 'example.com (000.00.255.112)' can't be established.
-RSA key fingerprint is SHA256:000000000000000000000000000000000.
-Are you sure you want to continue connecting (yes/no)? yes
-Warning: Permanently added 'github.com,000.00.255.112' (RSA) to the list of known hosts.
-```
+   SSH displays this fingerprint when it connects to an unknown host to protect you from [man-in-the-middle attacks](/previous-versions/windows/it-pro/windows-2000-server/cc959354(v=technet.10)#man-in-the-middle-attack). You should verify that the displayed fingerprint matches one of the fingerprints in the SSH public keys page, and then respond *yes*.
 
-SSH displays this fingerprint when it connects to an unknown host to protect you from [man-in-the-middle attacks](/previous-versions/windows/it-pro/windows-2000-server/cc959354(v=technet.10)#man-in-the-middle-attack). You should verify that the displayed fingerprint matches one of the fingerprints in the SSH public keys page.
+1. SSH displays a response like the following example:
 
-When you're asked if you want to continue connecting, enter *yes*. Once you accept the host's fingerprint, SSH doesn't prompt you again unless the fingerprint changes.
+   ```bash
+   Warning: Permanently added 'github.com,000.00.000.0' (ECDSA) to the list of known hosts.
+   Enter passphrase for key '/home/azureuser/.ssh/id_ed25519': 
+   ```
+1. Enter your passphrase. Git clones the repo and sets up the origin remote to connect with SSH for future Git commands. Once you accept the host's fingerprint, SSH doesn't prompt you again unless the fingerprint changes.
 
 ## Track code that comes from Git repositories
 
-When you submit a training job from the Python SDK or Machine Learning CLI, the files needed to train the model are uploaded to your workspace. If the `git` command is available on your development environment, the upload process checks if the files are stored in a Git repository, and uploads any Git repository information as part of the training job.
+When you submit a training job from the Python SDK or Machine Learning CLI, the files needed to train the model are uploaded to your workspace. If the `git` command is available on your development environment, the upload process checks if the source files are stored in a Git repository, and if so, uploads any Git repository information as part of the training job.
 
 The following information is sent for jobs that use an estimator, machine learning pipeline, or script run. The information is stored in the following training job properties:
 
@@ -130,7 +133,7 @@ The following information is sent for jobs that use an estimator, machine learni
 If the `git` command isn't available on your development environment, or your training files aren't located in a Git repository, no Git-related information is tracked.
 
 > [!TIP]
-> To check if the `git` command is available on your development environment, run the `git --version` command in a command line interface. If Git is installed and in your path, you receive a response similar to `git version 2.4.1`. For information on installing Git on your development environment, see the [Git website](https://git-scm.com/).
+> To check if the `git` command is available on your development environment, run the `git --version` command in a command line interface. If Git is installed and in your path, you receive a response similar to `git version 2.43.0`. For information on installing Git on your development environment, see the [Git website](https://git-scm.com/).
 
 ## View Git information
 
@@ -147,7 +150,7 @@ In your Azure Machine Learning workspace in Azure Machine Learning studio:
 1. Expand **logs** > **azureml**.
 1. Select the link that begins with **###_azure**.
 
-The logged information contains text similar to the following JSON code:
+The logged information contains JSON code similar to the following example:
 
 ```json
 "properties": {
@@ -168,23 +171,23 @@ The logged information contains text similar to the following JSON code:
 
 ### Python SDK V2
 
-After you submit a training run, a [Job](/python/api/azure-ai-ml/azure.ai.ml.entities.job) object is returned. The `properties` attribute of this object contains the logged Git information. For example, the following code retrieves the commit hash:
+After you submit a training run, a [Job](/python/api/azure-ai-ml/azure.ai.ml.entities.job) object is returned. The `properties` attribute of this object contains the logged Git information. For example, you can run the following command to retrieve the commit hash:
 
 ```python
 job.properties["azureml.git.commit"]
 ```
 
 ### Azure CLI V2
 
-Run the `az ml job show` command to display the `GitCommit` property. For example:
+Run the `az ml job show` command with the `--query` argument to display the Git information. For example, the following query retrieves the `GitCommit` property:
 
 ```azurecli
-az ml job show --name my_job_id --query "{GitCommit:properties.azureml.git.commit}"
+az ml job show --name my-job-id --query "{GitCommit:properties.azureml.git.commit} --resource-group my-resource-group --workspace-name my-workspace"
 ```
 
 ## Related content
 
 - [Access a compute instance terminal in your workspace](how-to-access-terminal.md)
 - [Launch Visual Studio Code integrated with Azure Machine Learning (preview)](how-to-launch-vs-code-remote.md)
-- [Use Version Control in VS Code](https://code.visualstudio.com/docs/editor/versioncontrol)
-- [Work with GitHub in VS Code](https://code.visualstudio.com/docs/editor/github)
+- [Use Version Control in Visual Studio Code](https://code.visualstudio.com/docs/editor/versioncontrol)
+- [Work with GitHub in Visual Studio Code](https://code.visualstudio.com/docs/editor/github)