search

instructlab / instructlab

InstructLab Command-Line Interface. Use this to chat with a model and execute the InstructLab workflow to train a model using custom taxonomy data.
https://instructlab.ai
Apache License 2.0
789 stars 298 forks source link

Add upgrade instructions to README.md #1381

Closed mairin closed 3 months ago

mairin commented 3 months ago

We don't have instructions on how to upgrade in the cli repo readme nor in the changelogs. It might be a good idea to have a thing in both places.

pip install instructlab --upgrade worked for me, but i dont know if i have to upgrade venv as well as a good practice or whatnot

sanskriti2005 commented 3 months ago

Hello! Can I be assigned to this?

leseb commented 3 months ago

Hello! Can I be assigned to this?

It's all yours now! Thanks!

sanskriti2005 commented 3 months ago

@leseb

Thanks for assigning me!

I just wanted some clarifications, I have to make changes to the CHANGELOG.md and the READEME.md file, right?

leseb commented 3 months ago

I don't think we need this in the CHANGELOG.md, we just include the pip install instructlab --upgrade once we ship a release in https://github.com/instructlab/instructlab/releases. However having this in the README is important. Thanks!