diff --git a/README.md b/README.md index 9b669de..f6ceabc 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,23 @@ # Fine-Tuning for LLM Research by AI Hero -This repo contains the code that will be run inside the container. The container is built and pushed to the repo using Github actions (see below). You can launch the fine tuning job using the `https://github.com/ai-hero/llm-research-orchestration` project with the data created with the `https://github.com/ai-hero/llm-research-data` project. +This repo contains the code that will be run inside the container. Alternatively, this code can also be run natively. The container is built and pushed to the repo using Github actions (see below). You can launch the fine tuning job using the examples in the `https://github.com/ai-hero/llm-research-examples` project with the data created with the `https://github.com/ai-hero/llm-research-data` project. ## Container -Our latest container we use for training is `rparundekar/fine_tune_research:{SHORT_SHA_ON_MAIN}`. You can launch jobs using this tag with the `llm-research-orchestration` project. +Our latest container we use for training is `rparundekar/fine_tune_research:{SHORT_SHA_ON_MAIN}`. You can launch jobs using this tag with the `llm-research-examples` project. + +## For Contributors +Installing this library locally. -## Setup ```sh -pip install -r requirements.txt +pip install . ``` -## Building Docker using Github Actions +### Building Docker using Github Actions Change the Github actions in the `.github` folder and set the right environment variables in Github to auto build the container and push to the right repo. -## Building a Docker Image Manually +### Building a Docker Image Manually Use a tag versioning by date / user as needed. For example, ```sh docker build . -t rparundekar/fine_tune_research:20230110_01 docker push rparundekar/fine_tune_research:20230110_01 ``` - -## Launching a Job -Please see the launch instructions in the `llm-research-fine-tuning` project. diff --git a/pyproject.toml b/pyproject.toml index a69e1a3..0623c0f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "aihero-research-finetuning" -version = "0.3.0" +version = "0.3.1" description = "Framework for open source research on fine-tuning LLMs" authors = [ {name = "Rahul Parundekar", email= "rahul@aihero.studio" },