lemms commited on
Commit
d185e19
Β·
verified Β·
1 Parent(s): c118c12

Update README for Gradio 4.44.1 and complete training features

Browse files
Files changed (1) hide show
  1. README.md +50 -15
README.md CHANGED
@@ -4,7 +4,7 @@ emoji: πŸš€
4
  colorFrom: blue
5
  colorTo: purple
6
  sdk: gradio
7
- sdk_version: 4.44.0
8
  app_file: app.py
9
  pinned: false
10
  license: gpl-3.0
@@ -12,29 +12,64 @@ license: gpl-3.0
12
 
13
  # OpenLLM Training Space
14
 
15
- This space provides training infrastructure for OpenLLM models.
16
 
17
  ## Features
18
 
19
- - 🎯 Model training pipeline
20
- - πŸ“Š Training monitoring
21
- - πŸ”„ Model versioning
22
- - πŸ“ˆ Performance tracking
 
23
 
24
- ## Usage
 
 
 
 
 
 
 
 
 
 
25
 
26
- 1. Upload your training data
27
- 2. Configure training parameters
28
- 3. Start training
29
- 4. Monitor progress
30
- 5. Download trained models
 
 
 
 
 
31
 
32
  ## Model Repositories
33
 
34
- - [openllm-small-extended-7k](https://huggingface.co/lemms/openllm-small-extended-7k)
35
- - [openllm-small-extended-8k](https://huggingface.co/lemms/openllm-small-extended-8k)
36
- - [openllm-training-data](https://huggingface.co/datasets/lemms/openllm-training-data)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
37
 
38
  ## License
39
 
40
  GPL-3.0 - See [LICENSE](LICENSE) for details.
 
 
 
 
 
4
  colorFrom: blue
5
  colorTo: purple
6
  sdk: gradio
7
+ sdk_version: 4.44.1
8
  app_file: app.py
9
  pinned: false
10
  license: gpl-3.0
 
12
 
13
  # OpenLLM Training Space
14
 
15
+ This space provides complete training infrastructure for OpenLLM models with real model training functionality.
16
 
17
  ## Features
18
 
19
+ - 🎯 **Real Model Training**: Actual PyTorch training with Transformers
20
+ - πŸ“Š **Training Monitoring**: Live progress tracking and loss monitoring
21
+ - πŸ”„ **Model Versioning**: Automatic model saving and uploading to HF Hub
22
+ - πŸ“ˆ **Performance Tracking**: Training metrics and completion status
23
+ - πŸš€ **Gradio 4.44.1**: Latest UI framework with enhanced compatibility
24
 
25
+ ## Complete Training Pipeline
26
+
27
+ ### What Happens When You Click "Start Training":
28
+
29
+ 1. **πŸ“₯ Model Loading**: Loads the 7k model from `lemms/openllm-small-extended-7k`
30
+ 2. **πŸ“Š Dataset Preparation**: Loads and tokenizes training data from `lemms/openllm-training-data`
31
+ 3. **βš™οΈ Training Setup**: Configures PyTorch Trainer with your parameters
32
+ 4. **πŸš€ Real Training**: Executes actual model training for specified steps
33
+ 5. **πŸ’Ύ Save & Upload**: Saves trained model and uploads to HF Hub as `lemms/openllm-{size}-extended-8k`
34
+
35
+ ### Training Configuration Options:
36
 
37
+ - **Model Size**: small, medium, large (currently supports small)
38
+ - **Max Steps**: 100-10,000 training iterations
39
+ - **Learning Rate**: 0.00001-0.001 (configurable)
40
+ - **Batch Size**: 1-16 samples per batch
41
+
42
+ ### Expected Results:
43
+
44
+ - **Training Time**: 10-30 minutes for 1000 steps (depending on HF Space resources)
45
+ - **Output Model**: `lemms/openllm-small-extended-8k` (or other sizes)
46
+ - **Model Files**: Complete PyTorch model with tokenizer and configuration
47
 
48
  ## Model Repositories
49
 
50
+ - [πŸ“š 7k Small Model](https://huggingface.co/lemms/openllm-small-extended-7k)
51
+ - [🎯 8k Small Model](https://huggingface.co/lemms/openllm-small-extended-8k)
52
+ - [πŸ“Š Training Dataset](https://huggingface.co/datasets/lemms/openllm-training-data)
53
+
54
+ ## Technical Details
55
+
56
+ - **Framework**: PyTorch with Transformers
57
+ - **UI**: Gradio 4.44.1 (latest stable version)
58
+ - **Training**: Mixed precision (FP16) for efficiency
59
+ - **Memory**: Optimized for HF Spaces with gradient accumulation
60
+ - **Dependencies**: Complete ML stack with all training utilities
61
+
62
+ ## Usage
63
+
64
+ 1. **Configure Parameters**: Set model size, steps, learning rate, and batch size
65
+ 2. **Start Training**: Click "Start Training" to begin the complete pipeline
66
+ 3. **Monitor Progress**: Watch real-time status updates and training progress
67
+ 4. **Access Results**: Find your trained model in the HF Hub repository
68
 
69
  ## License
70
 
71
  GPL-3.0 - See [LICENSE](LICENSE) for details.
72
+
73
+ ## Author
74
+
75
+ **Louis Chua Bean Chong** - OpenLLM Project Maintainer