Skip to content

Commit f6a1766

Browse files
committed
correct the docs links
1 parent ad311a0 commit f6a1766

File tree

2 files changed

+40
-40
lines changed

2 files changed

+40
-40
lines changed

README.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ ModelForge v2.0 is a complete architectural overhaul bringing **2x faster traini
2020
- 🏗️ **Modular Architecture** for easy extensibility
2121
- 🔒 **Production-Ready** with proper error handling and logging
2222

23-
**[See What's New in v2.0 →](docs/getting-started/whats-new.md)**
23+
**[See What's New in v2.0 →](https://github.com/RETR0-OS/ModelForge/docs/getting-started/whats-new.md)**
2424

2525
## 🚀 Features
2626

@@ -50,7 +50,7 @@ ModelForge v2.0 is a complete architectural overhaul bringing **2x faster traini
5050

5151
> **⚠️ macOS is NOT supported.** ModelForge requires NVIDIA CUDA which is not available on macOS. Use Linux or Windows with NVIDIA GPU.
5252
>
53-
> **Windows Users**: See [Windows Installation Guide](docs/installation/windows.md) for platform-specific instructions, especially for Unsloth support.
53+
> **Windows Users**: See [Windows Installation Guide](https://github.com/RETR0-OS/ModelForge/docs/installation/windows.md) for platform-specific instructions, especially for Unsloth support.
5454
5555
### Installation
5656

@@ -88,52 +88,52 @@ modelforge run
8888

8989
Open your browser to **http://localhost:8000** and start training!
9090

91-
**[Full Quick Start Guide →](docs/getting-started/quickstart.md)**
91+
**[Full Quick Start Guide →](https://github.com/RETR0-OS/ModelForge/docs/getting-started/quickstart.md)**
9292

9393
## 📚 Documentation
9494

9595
### Getting Started
96-
- **[Quick Start Guide](docs/getting-started/quickstart.md)** - Get up and running in 5 minutes
97-
- **[What's New in v2.0](docs/getting-started/whats-new.md)** - Major features and improvements
96+
- **[Quick Start Guide](https://github.com/RETR0-OS/ModelForge/docs/getting-started/quickstart.md)** - Get up and running in 5 minutes
97+
- **[What's New in v2.0](https://github.com/RETR0-OS/ModelForge/docs/getting-started/whats-new.md)** - Major features and improvements
9898

9999
### Installation
100-
- **[Windows Installation](docs/installation/windows.md)** - Complete Windows setup (including WSL and Docker)
101-
- **[Linux Installation](docs/installation/linux.md)** - Linux setup guide
102-
- **[Post-Installation](docs/installation/post-installation.md)** - Initial configuration
100+
- **[Windows Installation](https://github.com/RETR0-OS/ModelForge/docs/installation/windows.md)** - Complete Windows setup (including WSL and Docker)
101+
- **[Linux Installation](https://github.com/RETR0-OS/ModelForge/docs/installation/linux.md)** - Linux setup guide
102+
- **[Post-Installation](https://github.com/RETR0-OS/ModelForge/docs/installation/post-installation.md)** - Initial configuration
103103

104104
### Configuration & Usage
105-
- **[Configuration Guide](docs/configuration/configuration-guide.md)** - All configuration options
106-
- **[Dataset Formats](docs/configuration/dataset-formats.md)** - Preparing your training data
107-
- **[Training Tasks](docs/configuration/training-tasks.md)** - Understanding different tasks
108-
- **[Hardware Profiles](docs/configuration/hardware-profiles.md)** - Optimizing for your GPU
105+
- **[Configuration Guide](https://github.com/RETR0-OS/ModelForge/docs/configuration/configuration-guide.md)** - All configuration options
106+
- **[Dataset Formats](https://github.com/RETR0-OS/ModelForge/docs/configuration/dataset-formats.md)** - Preparing your training data
107+
- **[Training Tasks](https://github.com/RETR0-OS/ModelForge/docs/configuration/training-tasks.md)** - Understanding different tasks
108+
- **[Hardware Profiles](https://github.com/RETR0-OS/ModelForge/docs/configuration/hardware-profiles.md)** - Optimizing for your GPU
109109

110110
### Providers
111-
- **[Provider Overview](docs/providers/overview.md)** - Understanding providers
112-
- **[HuggingFace Provider](docs/providers/huggingface.md)** - Standard HuggingFace models
113-
- **[Unsloth Provider](docs/providers/unsloth.md)** - 2x faster training
111+
- **[Provider Overview](https://github.com/RETR0-OS/ModelForge/docs/providers/overview.md)** - Understanding providers
112+
- **[HuggingFace Provider](https://github.com/RETR0-OS/ModelForge/docs/providers/huggingface.md)** - Standard HuggingFace models
113+
- **[Unsloth Provider](https://github.com/RETR0-OS/ModelForge/docs/providers/unsloth.md)** - 2x faster training
114114

115115
### Training Strategies
116-
- **[Strategy Overview](docs/strategies/overview.md)** - Understanding strategies
117-
- **[SFT Strategy](docs/strategies/sft.md)** - Standard supervised fine-tuning
118-
- **[QLoRA Strategy](docs/strategies/qlora.md)** - Memory-efficient training
119-
- **[RLHF Strategy](docs/strategies/rlhf.md)** - Reinforcement learning
120-
- **[DPO Strategy](docs/strategies/dpo.md)** - Direct preference optimization
116+
- **[Strategy Overview](https://github.com/RETR0-OS/ModelForge/docs/strategies/overview.md)** - Understanding strategies
117+
- **[SFT Strategy](https://github.com/RETR0-OS/ModelForge/docs/strategies/sft.md)** - Standard supervised fine-tuning
118+
- **[QLoRA Strategy](https://github.com/RETR0-OS/ModelForge/docs/strategies/qlora.md)** - Memory-efficient training
119+
- **[RLHF Strategy](https://github.com/RETR0-OS/ModelForge/docs/strategies/rlhf.md)** - Reinforcement learning
120+
- **[DPO Strategy](https://github.com/RETR0-OS/ModelForge/docs/strategies/dpo.md)** - Direct preference optimization
121121

122122
### API Reference
123-
- **[REST API](docs/api-reference/rest-api.md)** - Complete API documentation
124-
- **[Training Config Schema](docs/api-reference/training-config.md)** - Configuration options
123+
- **[REST API](https://github.com/RETR0-OS/ModelForge/docs/api-reference/rest-api.md)** - Complete API documentation
124+
- **[Training Config Schema](https://github.com/RETR0-OS/ModelForge/docs/api-reference/training-config.md)** - Configuration options
125125

126126
### Troubleshooting
127-
- **[Common Issues](docs/troubleshooting/common-issues.md)** - Frequently encountered problems
128-
- **[Windows Issues](docs/troubleshooting/windows-issues.md)** - Windows-specific troubleshooting
129-
- **[FAQ](docs/troubleshooting/faq.md)** - Frequently asked questions
127+
- **[Common Issues](https://github.com/RETR0-OS/ModelForge/docs/troubleshooting/common-issues.md)** - Frequently encountered problems
128+
- **[Windows Issues](https://github.com/RETR0-OS/ModelForge/docs/troubleshooting/windows-issues.md)** - Windows-specific troubleshooting
129+
- **[FAQ](https://github.com/RETR0-OS/ModelForge/docs/troubleshooting/faq.md)** - Frequently asked questions
130130

131131
### Contributing
132-
- **[Contributing Guide](docs/contributing/contributing.md)** - How to contribute
133-
- **[Architecture](docs/contributing/architecture.md)** - Understanding the codebase
134-
- **[Model Configurations](docs/contributing/model-configs.md)** - Adding model recommendations
132+
- **[Contributing Guide](https://github.com/RETR0-OS/ModelForge/docs/contributing/contributing.md)** - How to contribute
133+
- **[Architecture](https://github.com/RETR0-OS/ModelForge/docs/contributing/architecture.md)** - Understanding the codebase
134+
- **[Model Configurations](https://github.com/RETR0-OS/ModelForge/docs/contributing/model-configs.md)** - Adding model recommendations
135135

136-
**[📖 Full Documentation Index →](docs/README.md)**
136+
**[📖 Full Documentation Index →](https://github.com/RETR0-OS/ModelForge/docs/README.md)**
137137

138138
## 🔧 Platform Support
139139

@@ -144,16 +144,16 @@ Open your browser to **http://localhost:8000** and start training!
144144
| **WSL 2** | ✅ Full support | ✅ Full support | Recommended for Windows users |
145145
| **Docker** | ✅ Full support | ✅ Full support | With NVIDIA runtime |
146146

147-
**[Platform-Specific Installation Guides →](docs/installation/)**
147+
**[Platform-Specific Installation Guides →](https://github.com/RETR0-OS/ModelForge/docs/installation/)**
148148

149149
## ⚠️ Important Notes
150150

151151
### Windows Users
152152

153153
**Unsloth provider is NOT supported on native Windows.** For 2x faster training with Unsloth:
154154

155-
1. **Option 1: WSL (Recommended)** - [WSL Installation Guide](docs/installation/windows.md#option-2-wsl-installation-recommended)
156-
2. **Option 2: Docker** - [Docker Installation Guide](docs/installation/windows.md#option-3-docker-installation)
155+
1. **Option 1: WSL (Recommended)** - [WSL Installation Guide](https://github.com/RETR0-OS/ModelForge/docs/installation/windows.md#option-2-wsl-installation-recommended)
156+
2. **Option 2: Docker** - [Docker Installation Guide](https://github.com/RETR0-OS/ModelForge/docs/installation/windows.md#option-3-docker-installation)
157157

158158
The HuggingFace provider works perfectly on native Windows.
159159

@@ -170,7 +170,7 @@ When using Unsloth provider, you **MUST** specify a fixed `max_sequence_length`:
170170

171171
Auto-inference (`max_seq_length: -1`) is **NOT supported** with Unsloth.
172172

173-
**[Learn more about Unsloth →](docs/providers/unsloth.md)**
173+
**[Learn more about Unsloth →](https://github.com/RETR0-OS/ModelForge/docs/providers/unsloth.md)**
174174

175175
## 📂 Dataset Format
176176

@@ -192,7 +192,7 @@ ModelForge uses JSONL format. Each task has specific fields:
192192
{"context": "Document text...", "question": "What is X?", "answer": "X is..."}
193193
```
194194

195-
**[Complete Dataset Format Guide →](docs/configuration/dataset-formats.md)**
195+
**[Complete Dataset Format Guide →](https://github.com/RETR0-OS/ModelForge/docs/configuration/dataset-formats.md)**
196196

197197
## 🤝 Contributing
198198

@@ -204,11 +204,11 @@ We welcome contributions! ModelForge v2.0's modular architecture makes it easy t
204204
- **Improve documentation**
205205
- **Fix bugs and add features**
206206

207-
**[Contributing Guide →](docs/contributing/contributing.md)**
207+
**[Contributing Guide →](https://github.com/RETR0-OS/ModelForge/docs/contributing/contributing.md)**
208208

209209
### Adding Model Recommendations
210210

211-
ModelForge uses modular configuration files for model recommendations. See the **[Model Configuration Guide](docs/contributing/model-configs.md)** for instructions on adding new recommended models.
211+
ModelForge uses modular configuration files for model recommendations. See the **[Model Configuration Guide](https://github.com/RETR0-OS/ModelForge/docs/contributing/model-configs.md)** for instructions on adding new recommended models.
212212

213213
## 🛠 Tech Stack
214214

@@ -232,7 +232,7 @@ MIT License - see [LICENSE](LICENSE) file for details.
232232

233233
## 📧 Support
234234

235-
- **Documentation**: [docs/](docs/)
235+
- **Documentation**: [https://github.com/RETR0-OS/ModelForge/docs/](https://github.com/RETR0-OS/ModelForge/docs/)
236236
- **Issues**: [GitHub Issues](https://github.com/RETR0-OS/ModelForge/issues)
237237
- **Discussions**: [GitHub Discussions](https://github.com/RETR0-OS/ModelForge/discussions)
238238
- **PyPI**: [modelforge-finetuning](https://pypi.org/project/modelforge-finetuning/)
@@ -241,4 +241,4 @@ MIT License - see [LICENSE](LICENSE) file for details.
241241

242242
**ModelForge v2.0 - Making LLM fine-tuning accessible to everyone** 🚀
243243

244-
**[Get Started →](docs/getting-started/quickstart.md)** | **[Documentation →](docs/)** | **[GitHub →](https://github.com/RETR0-OS/ModelForge)**
244+
**[Get Started →](https://github.com/RETR0-OS/ModelForge/docs/getting-started/quickstart.md)** | **[Documentation →](https://github.com/RETR0-OS/ModelForge/docs/)** | **[GitHub →](https://github.com/RETR0-OS/ModelForge)**

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "modelforge-finetuning"
3-
version = "2.0.2"
3+
version = "2.0.3"
44
description = "ModelForge: A no-code toolkit for fine-tuning HuggingFace models"
55
authors = [
66
{name = "R3tr0 M1ll3r", email = "r3tr0.m1ll3r@gmail.com"},
@@ -63,4 +63,4 @@ include-package-data = true
6363
]
6464

6565
[project.urls]
66-
Documentation = "https://modelforge.readthedocs.io"
66+
Documentation = "https://modelforge-finetuning.readthedocs.io"

0 commit comments

Comments
 (0)