Skip to content

Create new landing page for sagemaker python sdk #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Aditi2424 opened this issue May 19, 2025 · 5 comments
Open

Create new landing page for sagemaker python sdk #1

Aditi2424 opened this issue May 19, 2025 · 5 comments
Labels
Amazon Q development agent Generate new features or iterate code based on issue descriptions and comments. documentation Improvements or additions to documentation

Comments

@Aditi2424
Copy link
Owner

What did you find confusing? Please describe.
The landing page https://sagemaker.readthedocs.io/en/stable/ is very text heavy and does not components and features, installation guide, etc.

Describe how documentation can be improved
summarize the
Components - Training (Debugger)
MLOps
SageMaker Core
Inference
Jumpstart

and
SDK Features -
Intelligent Defaults
Local Mode

Create a quickstart guide and installation steps

Additional context
Add any other context or screenshots about the documentation request here.

@Aditi2424 Aditi2424 added documentation Improvements or additions to documentation Amazon Q development agent Generate new features or iterate code based on issue descriptions and comments. Amazon Q transform agent Upgrade codebase to latest language version. labels May 19, 2025
Copy link

amazon-q-developer bot commented May 19, 2025

✅ I finished the proposed code changes, and the pull request is ready for review: #2.

Comment on the pull request to provide feedback and request a new iteration.

Copy link

⏳ I'm working on generating code for this issue. I'll update this issue with a comment and open a pull request when I'm done.

Copy link

I'm getting ready to upgrade your code to Java 17.

Copy link

I'm running the GitHub Actions workflow required to transform your code.

@Aditi2424 Aditi2424 removed the Amazon Q transform agent Upgrade codebase to latest language version. label May 19, 2025
Copy link

Before I can start on the transformation request, you need to enable GitHub Actions for this repository, and you need at least one runner online.

To upgrade your code, complete the following steps:

  1. Ensure GitHub Actions is enabled for this repository.
  2. Ensure at least one runner is online.
  3. Modify your config file within the .github/workflows/ path to include the following snippet (customize verify step):
name: Q Code Transformation

on:
  push:
    branches:
      - 'Q-TRANSFORM-issue-*'

jobs:
  q-code-transformation:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-java@v3
        with:
          java-version: '17'
          distribution: 'adopt'

      - name: Build and copy dependencies
        run: |
          mvn ${{ env.MAVEN_CLI_OPTS }} verify
          mvn ${{ env.MAVEN_CLI_OPTS }} dependency:copy-dependencies -DoutputDirectory=dependencies -Dmdep.useRepositoryLayout=true -Dmdep.copyPom=true -Dmdep.addParentPoms=true

      - name: Upload artifacts
        uses: actions/upload-artifact@v4
        with:
          name: q-code-transformation-dependencies
          path: dependencies
  1. Merge or commit the changes to your repository's default branch.
  2. Return to this issue and restart the transformation action by applying the Amazon Q transform agent label. If the label is already applied, remove it and re-apply.

For more information, see managing workflow runs in the GitHub documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Amazon Q development agent Generate new features or iterate code based on issue descriptions and comments. documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant