Skip to content
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

Rewording examples Readme to highlight examples #2086

Merged
merged 24 commits into from
Jan 30, 2023
Merged

Conversation

agunapal
Copy link
Collaborator

Description

Editing the examples README to ensure its easier to find the correct examples

Fixes #(issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Feature/Issue validation/testing

N/A

Checklist:

  • Did you have fun?
  • Have you added tests that prove your fix is effective or that this feature works?
  • Has code been commented, particularly in hard-to-understand areas?
  • Have you made corresponding changes to the documentation?

@msaroufim
Copy link
Member

msaroufim commented Jan 21, 2023

Liking the new direction! Let's also use this PR to beef up docs/README.md as well since I figure that's where most people might be navigating our docs

@codecov
Copy link

codecov bot commented Jan 21, 2023

Codecov Report

Merging #2086 (4f9348d) into master (4ac7940) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2086   +/-   ##
=======================================
  Coverage   53.36%   53.36%           
=======================================
  Files          71       71           
  Lines        3225     3225           
  Branches       56       56           
=======================================
  Hits         1721     1721           
  Misses       1504     1504           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

examples/README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@chauhang
Copy link
Contributor

New direction is looking good. Please add pointers for following as well:

  • HF LargeModel separately
  • Link for Kubernetes examples (point to the relevant readme)
  • Link for KServe examples (point to the relevant readme)
  • Link for MLflow-TorchServe examples

@agunapal
Copy link
Collaborator Author

@chauhang Thanks. Addressed your review comments

@chauhang chauhang merged commit 714c2f2 into master Jan 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants