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

Add LLM and ML engineering books to README #3159

Merged
merged 19 commits into from
Oct 31, 2024
Merged

Add LLM and ML engineering books to README #3159

merged 19 commits into from
Oct 31, 2024

Conversation

htahir1
Copy link
Contributor

@htahir1 htahir1 commented Oct 31, 2024

Describe changes

I implemented/fixed _ to achieve _.

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
  • If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

@htahir1 htahir1 requested a review from strickvl October 31, 2024 09:30
Copy link
Contributor

coderabbitai bot commented Oct 31, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the internal To filter out internal PRs and issues label Oct 31, 2024
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@htahir1 htahir1 requested a review from strickvl October 31, 2024 10:14
@htahir1 htahir1 marked this pull request as ready for review October 31, 2024 10:14
@strickvl strickvl added the documentation Improvements or additions to documentation label Oct 31, 2024
@htahir1 htahir1 merged commit 824f99a into develop Oct 31, 2024
8 checks passed
@htahir1 htahir1 deleted the doc/readmeupgrade branch October 31, 2024 10:46
htahir1 added a commit that referenced this pull request Oct 31, 2024
* Add LLM and ML engineering books to README

* Update book section layout and improve description

* Update book display layout in README.md

* Update book information in README.md

* Update README.md

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

* Update README.md

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

* Remove unnecessary HTML tags for README.md layout

* Update image alignment in README.md file

* Update image alignment in README.md

* Improve image alignment in README.md

* Fix image tags in README for book covers

* Update image tag in README for LLM Engineer's Handbook

* Update link formatting in README.md

* Update alignment of book links in README.md

* Update deployment options link in README.md

* Add ZenML Pro sign up link to README.md

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
(cherry picked from commit 824f99a)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants