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

Refine README.md as self-contained Getting Started #34

Merged
merged 39 commits into from
Jul 5, 2024

Conversation

goodsong81
Copy link
Contributor

@goodsong81 goodsong81 commented Jul 3, 2024

image

  • Remove notebooks (to be replaced by external OpenVINO notebooks)
  • Update "Features" with supported methods and models
  • Update "Quick Start" with simplest use-case
  • Gather static files to docs/source/_static for consistency
  • Append metadata like license / contributing info at the end

@goodsong81 goodsong81 force-pushed the doc/refine-get-started branch from 10d718b to 37951b9 Compare July 3, 2024 06:05
@goodsong81 goodsong81 force-pushed the doc/refine-get-started branch 4 times, most recently from da763f3 to 8350e37 Compare July 3, 2024 07:47
@goodsong81 goodsong81 force-pushed the doc/refine-get-started branch from 8350e37 to f13ccc3 Compare July 3, 2024 07:47
@goodsong81 goodsong81 marked this pull request as ready for review July 3, 2024 08:42
Copy link
Contributor

@GalyaZalesskaya GalyaZalesskaya left a comment

Choose a reason for hiding this comment

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

Thank you for this wonderful, detailed, easy to read README, left some minor comments

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
goodsong81 and others added 2 commits July 4, 2024 08:06
Co-authored-by: Galina Zalesskaya <galina.zalesskaya@intel.com>
Co-authored-by: Galina Zalesskaya <galina.zalesskaya@intel.com>
goodsong81 and others added 5 commits July 4, 2024 08:06
Co-authored-by: Galina Zalesskaya <galina.zalesskaya@intel.com>
Co-authored-by: Galina Zalesskaya <galina.zalesskaya@intel.com>
Co-authored-by: Galina Zalesskaya <galina.zalesskaya@intel.com>
Co-authored-by: Galina Zalesskaya <galina.zalesskaya@intel.com>
Co-authored-by: Galina Zalesskaya <galina.zalesskaya@intel.com>
Copy link

codecov bot commented Jul 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (releases/1.0.0@e2cd66f). Learn more about missing BASE report.

Additional details and impacted files
@@                Coverage Diff                @@
##             releases/1.0.0      #34   +/-   ##
=================================================
  Coverage                  ?   90.85%           
=================================================
  Files                     ?       18           
  Lines                     ?     1061           
  Branches                  ?        0           
=================================================
  Hits                      ?      964           
  Misses                    ?       97           
  Partials                  ?        0           
Flag Coverage Δ
dev-py310 90.85% <ø> (?)
dev-py311 90.85% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@goodsong81 goodsong81 force-pushed the doc/refine-get-started branch from e71bfd3 to 33be24f Compare July 3, 2024 23:43
GalyaZalesskaya
GalyaZalesskaya previously approved these changes Jul 4, 2024
negvet
negvet previously approved these changes Jul 4, 2024
Copy link
Collaborator

@negvet negvet left a comment

Choose a reason for hiding this comment

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

Great update, thank you!
See my minor comments below

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
goodsong81 and others added 2 commits July 5, 2024 10:00
Co-authored-by: Evgeny Tsykunov <evgeny.tsykunov@intel.com>
@goodsong81 goodsong81 dismissed stale reviews from negvet and GalyaZalesskaya via 426a5cf July 5, 2024 01:01
goodsong81 and others added 4 commits July 5, 2024 10:01
Co-authored-by: Evgeny Tsykunov <evgeny.tsykunov@intel.com>
Co-authored-by: Galina Zalesskaya <galina.zalesskaya@intel.com>
@goodsong81 goodsong81 merged commit 405b93f into releases/1.0.0 Jul 5, 2024
4 checks passed
@goodsong81 goodsong81 deleted the doc/refine-get-started branch July 5, 2024 01:20
@goodsong81 goodsong81 added this to the 1.0.0 milestone Jul 11, 2024
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.

3 participants