Skip to content

Commit 79cb7eb

Browse files
committed
Update train.mdx with Wandb configuration and requirements
- Added detailed requirements for training, including Huggingface token and model details - Included Wandb login and configuration instructions - Updated documentation with environment variables for Wandb logging
1 parent 48d4c94 commit 79cb7eb

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

docs/train.mdx

+22-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,11 @@ praisonai train init
2828

2929
## Required
3030

31-
1. HF_TOKEN
32-
2. Below config.yaml file in the same directory
31+
1. Huggingface token
32+
2. Base model to train on (e.g. unsloth/Meta-Llama-3.1-8B-Instruct-bnb-4bit)
33+
3. Dataset to train on (e.g. yahma/alpaca-cleaned)
34+
4. Huggingface model name to upload to (e.g. mervinpraison/llama3.1-instruct) (Optional)
35+
5. Ollama model name to upload to (e.g. mervinpraison/llama3.1-instruct) (Optional)
3336

3437
## To upload to ollama.com (Linux)
3538

@@ -119,4 +122,21 @@ quantization_method:
119122

120123
```bash
121124
praisonai train
125+
```
126+
127+
## wandb
128+
129+
```bash
130+
wandb login
131+
```
132+
133+
<Note>
134+
Get the key from [here](https://wandb.ai/site/login)
135+
</Note>
136+
137+
```bash
138+
export PRAISON_WANDB=True
139+
export WANDB_LOG_MODEL=checkpoint
140+
export WANDB_PROJECT=praisonai-test
141+
export PRAISON_WANDB_RUN_NAME=praisonai-train
122142
```

praisonai/setup/setup_conda_env.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,6 @@ $PIP_FULL_PATH install "unsloth[colab-new] @ git+https://github.com/unslothai/un
100100
$PIP_FULL_PATH install --no-deps "trl<0.9.0" peft accelerate bitsandbytes
101101
$PIP_FULL_PATH install unsloth_zoo
102102
$PIP_FULL_PATH install cut_cross_entropy
103-
$PIP_FULL_PATH install sentencepiece protobuf datasets huggingface_hub hf_transfer
103+
$PIP_FULL_PATH install sentencepiece protobuf datasets huggingface_hub hf_transfer wandb
104104

105105
echo "Setup completed successfully!"

0 commit comments

Comments
 (0)