Skip to content

Commit 529efb8

Browse files
Update library definition in README and setup.py
1 parent 266b6ff commit 529efb8

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,7 @@ Other scenarios include but not limited to connecting to a remote Jupyter Notebo
2020
Also see our [Frequently Asked Questions](FAQ.md), especially if you're using Windows on your local machine.
2121

2222
## How it works
23-
SageMaker SSH helper uses AWS Systems Manager (SSM) Session Manager, to register the SageMaker container in SSM, followed
24-
by creating an SSM session between your client machine and the SageMaker container. Then you can SSH into SageMaker by creating an SSH connection
25-
on top of the SSM session, that allows opening a Linux shell, and/or configuring bidirectional SSH port forwarding to
26-
enable applications like remote development/debugging/desktop, and others.
23+
SageMaker SSH helper uses AWS Systems Manager (SSM) Session Manager, to register the SageMaker container in SSM, followed by creating an SSM session between your client machine and the SageMaker container. Then you can "SSH into SageMaker" by creating an SSH (Secure Shell) connection on top of the SSM session, that allows opening a Linux shell, and/or configuring bidirectional SSH port forwarding to enable applications like remote development/debugging/desktop, and others.
2724

2825
![Screenshot](images/layers.png)
2926

setup.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,11 @@
4949
description="A helper library to connect into Amazon SageMaker with AWS Systems Manager and SSH (Secure Shell)",
5050
long_description="SageMaker SSH Helper is a library that helps you to securely connect to Amazon SageMaker's "
5151
"training jobs, processing jobs, realtime inference endpoints, and SageMaker Studio notebook "
52-
"containers for fast interactive experimentation, remote debugging, and advanced troubleshooting."
52+
"containers for fast interactive experimentation, remote debugging, and advanced troubleshooting, "
53+
"also known as \"SSH into SageMaker\"."
5354
"\n\n"
54-
"For the full description see [README.md]"
55-
"(https://github.com/aws-samples/sagemaker-ssh-helper/blob/main/README.md).",
55+
"For the documentation, see the repo [https://github.com/aws-samples/sagemaker-ssh-helper/]"
56+
"(https://github.com/aws-samples/sagemaker-ssh-helper/).",
5657
long_description_content_type='text/markdown',
5758
url='https://github.com/aws-samples/sagemaker-ssh-helper',
5859
packages=setuptools.find_packages(),

0 commit comments

Comments
 (0)