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

Docs: Update training README #218

Merged
merged 1 commit into from
Sep 26, 2024

Conversation

kelbrown20
Copy link
Contributor

@kelbrown20 kelbrown20 commented Sep 20, 2024

Description: This PR makes small updates to the training library README

You can see the preview here as well: https://github.com/kelbrown20/kelly-training/tree/update-train-readme

@mergify mergify bot added documentation Improvements or additions to documentation ci-failure labels Sep 20, 2024
@kelbrown20 kelbrown20 force-pushed the update-train-readme branch 3 times, most recently from dbf5d36 to b4789b2 Compare September 20, 2024 14:41
@mergify mergify bot removed the ci-failure label Sep 20, 2024
@mergify mergify bot added the ci-failure label Sep 22, 2024
@mergify mergify bot removed the ci-failure label Sep 22, 2024
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Member

@RobotSail RobotSail 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 the awesome PR @kelbrown20 ! I have one minor comment, but otherwise LGTM

README.md Show resolved Hide resolved
README.md Outdated
Install the library for development:

```bash
pip install instructlab-training -e
Copy link
Contributor

Choose a reason for hiding this comment

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

pip install -e ./training if training is cloned locally

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ill update that now!

Copy link
Contributor

@JamesKunstle JamesKunstle left a comment

Choose a reason for hiding this comment

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

lgtm!

Copy link
Contributor

mergify bot commented Sep 26, 2024

This pull request has merge conflicts that must be resolved before it can be
merged. @kelbrown20 please rebase it. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Sep 26, 2024
@RobotSail
Copy link
Member

@mergify rebase

Copy link
Contributor

mergify bot commented Sep 26, 2024

rebase

☑️ Nothing to do

  • -conflict [📌 rebase requirement]
  • -closed [📌 rebase requirement]
  • queue-position = -1 [📌 rebase requirement]
  • any of:
    • #commits-behind > 0 [📌 rebase requirement]
    • #commits > 1 [📌 rebase requirement]
    • -linear-history [📌 rebase requirement]

Signed-off-by: Kelly Brown <[email protected]>
@mergify mergify bot added ci-failure and removed needs-rebase labels Sep 26, 2024
@mergify mergify bot merged commit 7bc49bb into instructlab:main Sep 26, 2024
6 of 7 checks passed
@nathan-weinberg
Copy link
Member

This shouldn't have automerged and broke Markdown linting CI - fix here: #231

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci-failure documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants