ModelForge/mkdocs.yml at main · ForgeOpus/ModelForge · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
site_name: ModelForge Documentation
site_description: Complete documentation for ModelForge - A no-code toolkit for fine-tuning Large Language Models
site_author: R3tr0 M1ll3r
site_url: https://modelforge.readthedocs.io

repo_name: forgeopus/modelforge
repo_url: https://github.com/forgeopus/modelforge

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

markdown_extensions:
  - admonition
  - codehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true

nav:
  - Home: README.md

  - Getting Started:
    - Quick Start Guide: getting-started/quickstart.md
    - What's New in v3: getting-started/whats-new.md

  - Installation:
    - Windows Installation: installation/windows.md
    - Linux Installation: installation/linux.md
    - macOS (Apple Silicon): installation/macos-mps.md
    - Post-Installation Setup: installation/post-installation.md

  - Configuration:
    - Configuration Guide: configuration/configuration-guide.md
    - Dataset Formats: configuration/dataset-formats.md
    - Training Tasks: configuration/training-tasks.md
    - Hardware Profiles: configuration/hardware-profiles.md

  - Providers:
    - Provider Overview: providers/overview.md
    - HuggingFace Provider: providers/huggingface.md
    - Unsloth Provider: providers/unsloth.md
    - Adding Custom Providers: providers/custom-providers.md

  - Training Strategies:
    - Strategy Overview: strategies/overview.md
    - Supervised Fine-Tuning (SFT): strategies/sft.md
    - QLoRA Strategy: strategies/qlora.md
    - RLHF Strategy: strategies/rlhf.md
    - DPO Strategy: strategies/dpo.md
    - Adding Custom Strategies: strategies/custom-strategies.md

  - API Reference:
    - REST API Documentation: api-reference/rest-api.md
    - Training Configuration Schema: api-reference/training-config.md
    - Response Formats: api-reference/responses.md

  - Troubleshooting:
    - Common Issues: troubleshooting/common-issues.md
    - Windows-Specific Issues: troubleshooting/windows-issues.md
    - FAQ: troubleshooting/faq.md
    - Performance Optimization: troubleshooting/performance.md

  - Contributing:
    - Contributing Guide: contributing/contributing.md
    - Development Setup: contributing/development.md
    - Architecture Overview: contributing/architecture.md
    - Model Configurations: contributing/model-configs.md

plugins:
  - search
  - awesome-pages

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/forgeopus/modelforge
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/modelforge-finetuning/