refactor README; hardcode links to quarto docs; add additional quarto doc pages #2295
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
djsaunde
requested review from
winglian,
NanoCode012,
bursteratom and
SalmanMohammadi
winglian
reviewed
Jan 28, 2025
README.md
Outdated
Comment on lines
27
to
36
| Axolotl is a tool designed to streamline the fine-tuning of various AI models. With | ||
| support for multiple model architectures and training configurations, Axolotl makes it | ||
| easy to get started with model fine-tuning. | ||
|
|
||
| Axolotl is designed to work with YAML config files that contain everything you need | ||
| to preprocess a dataset, train or fine-tune a model, run model inference or evaluation, | ||
| and much more. |
There was a problem hiding this comment.
Could we rebrand to general post-training rather than just fine-tuning? cc @winglian
There was a problem hiding this comment.
Will wait for @winglian's thoughts on this :) But I agree.
There was a problem hiding this comment.
yeah, post-training works for me!
djsaunde
force-pushed
the
readme-update
branch
from
7109697 to
fcf28a2
Compare
winglian
force-pushed
the
readme-update
branch
from
4d09ed1 to
724d68d
Compare
winglian
approved these changes
Jan 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Title. Moved a lot of README content out into our quarto documentation and added links to it in the README.
Note: quarto doesn't seem to have native support for README.md, which would make this a bit neater w.r.t. linking out to quarto docs, but for now I have hardcoded links instead.
Motivation and Context
README was getting quite large and a bit unfocused.
How has this been tested?
N/A.
Screenshots (if appropriate)
N/A.
Types of changes
README updates, additional quarto documentation pages.