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

Updated readme file with better design, less text #1265

Merged
merged 11 commits into from
Nov 14, 2024
Merged

Conversation

ServiAmirPM
Copy link
Collaborator

@ServiAmirPM ServiAmirPM commented Nov 12, 2024

Still requires more modeifications (results, features, tutorials)

Pull Request Description:

  • Re-structure - changed the way the document is structured (table of content), including changing titles names
  • Redesigned the header - with better look and feel, with as much information in the header.
  • Removed tutorials from the tutorials section in the readme - will add some back after re-structuring the tutorials.
  • Added visuals to the page for better look and feel, and to better explain the product.
  • improved the quantization flow table and added 4 tutorials to it.
  • Re-ordered the Resources section, making it clear that API is per quantization method
  • Hidden (collapsed) the supported version table. users can open it on demand
  • Supported features - didn't touch it - still needs work
  • Quantization - didn't touch it - still needs work
  • Results - removed text, still requires updating the numbers, add mixed percision and the update graph
  • Toubleshooting and community - added community to this section.
  • Updated the license section with text and a badge

Checklist before requesting a review:

  • I set the appropriate labels on the pull request.
  • I have added/updated the release note draft (if necessary).
  • I have updated the documentation to reflect my changes (if necessary).
  • All function and files are well documented.
  • All function and classes have type hints.
  • There is a licenses in all file.
  • The function and variable names are informative.
  • I have checked for code duplications.
  • I have added new unittest (if necessary).

Still requires more modeifications (results, features, tutorials)
@ofirgo
Copy link
Collaborator

ofirgo commented Nov 13, 2024

@ServiAmirPM
Please provide more details regarding the changes in the PR description (what are the main changes to the readme, what was added/removed, etc.), both for documentation and to make my review easier 😄

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 Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
tutorials - Changed "the basics of deploying your first model" to "the basics of MCT tool"
fixed Ofir's review comments
@ServiAmirPM ServiAmirPM merged commit 0bcf7ab into main Nov 14, 2024
41 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants