Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

Doc cleanup #1095

Merged
msaroufim merged 16 commits into from
Jun 16, 2021
Merged

Doc cleanup #1095

msaroufim merged 16 commits into from
Jun 16, 2021

Conversation

@msaroufim
Copy link
Member

@msaroufim msaroufim commented May 24, 2021 •
edited
Loading

Summary of changes

  • Updating CI build spec to cuda 10.2
  • Removing codebuild readme and rolling it into DOCKER instructions
  • Compressed CUDA instructions in docker readme
  • Adding link to examples in docs/
  • Removing cu92 dangling requirement file
  • Added regression and benchmark test as a requirement in CONTRIBUTING.md
  • Added workflow archiver mention in README
  • References to benchmark automation script for big changes to torchserve
  • Added references to metrics, kubernetes and workflow in README
  • Lots of small improvements to /docs

TODO in another PR:

  • Workflow docs refactor
  • python request, jquery, flask example with snapshots and custom config
  • Mention snapshots more prominently as a resilience feature
  • Metrics loading in Python (context.metrics?), Prometheus and Grafana

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-win
  • Commit ID: 459b338
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-gpu
  • Commit ID: 459b338
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-win
  • Commit ID: fe75719
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@msaroufim msaroufim requested review from chauhang and maaquib May 24, 2021 21:42
@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-gpu
  • Commit ID: fe75719
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-win
  • Commit ID: 7221c23
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-gpu
  • Commit ID: 7221c23
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-win
  • Commit ID: d08f013
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-gpu
  • Commit ID: d08f013
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-cpu
  • Commit ID: 56e6148
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-win
  • Commit ID: 35a2ed6
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-gpu
  • Commit ID: 35a2ed6
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@msaroufim msaroufim changed the title [WIP] Comprehensive doc cleanup Doc cleanup May 24, 2021
@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-win
  • Commit ID: 56e6148
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-win
  • Commit ID: 38a1c4d
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-gpu
  • Commit ID: 38a1c4d
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-gpu
  • Commit ID: 56e6148
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-win
  • Commit ID: 3c77d17
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 24, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-gpu
  • Commit ID: 3c77d17
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 26, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-win
  • Commit ID: 5e8b07a
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@sagemaker-neo-ci-bot
Copy link
Collaborator

sagemaker-neo-ci-bot commented May 26, 2021

AWS CodeBuild CI Report

  • CodeBuild project: torch-serve-build-gpu
  • Commit ID: 5e8b07a
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

maaquib
maaquib reviewed Jun 7, 2021
View reviewed changes
Copy link
Collaborator

@maaquib maaquib left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes, added inline

HamidShojanazeri
HamidShojanazeri reviewed Jun 16, 2021
View reviewed changes
HamidShojanazeri
HamidShojanazeri approved these changes Jun 16, 2021
View reviewed changes
Copy link
Collaborator

@HamidShojanazeri HamidShojanazeri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @msaroufim, LGTM.

@msaroufim msaroufim merged commit fd4e3e8 into master Jun 16, 2021
@msaroufim msaroufim deleted the readmerefactor branch June 16, 2022 01:39
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@chauhang chauhang Awaiting requested review from chauhang

@lxning lxning Awaiting requested review from lxning

2 more reviewers

@maaquib maaquib maaquib approved these changes

@HamidShojanazeri HamidShojanazeri HamidShojanazeri approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@msaroufim @sagemaker-neo-ci-bot @maaquib @HamidShojanazeri