OpenJudge/mkdocs.yml at main · helloml0326/OpenJudge · 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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
site_name: OpenJudge
site_url: https://modelscope.github.io/OpenJudge/
site_description: "A One-Stop Reward Model Platform for training, building, and applying reward models. Supports 35+ pre-built models, RLHF training, LLM evaluation, and AI alignment."
site_author: "The OpenJudge Team"
repo_url: https://github.com/modelscope/OpenJudge
repo_name: modelscope/OpenJudge
copyright: "Copyright &copy; 2025 OpenJudge Team"
theme:
  name: shadcn
  show_stargazers: true
  git_enabled: false
  nav_sort: false
  features:
    - content.code.copy
    - content.code.annotate
nav:
  - Overview: index.md

  - Get Started:
      - Quick Start: get_started/quickstart.md
      - Evaluate an AI Agent: get_started/evaluate_ai_agents.md
      - Build Reward for Training: get_started/build_reward.md
      - Core Concepts: get_started/core_concepts.md

  - Built-in Graders:
      - Overview: built_in_graders/overview.md
      - General Graders: built_in_graders/general.md
      - Agent Graders: built_in_graders/agent_graders.md
      - Multimodal Graders: built_in_graders/multimodal.md
      - Code & Math Graders: built_in_graders/code_math.md
      - Text Graders: built_in_graders/text.md
      - Format Graders: built_in_graders/format.md

  - Building Graders:
      - Overview: building_graders/overview.md
      - Create Custom Graders: building_graders/create_custom_graders.md
      - Generate Graders from Data: building_graders/generate_graders_from_data.md
      # - Train Reward Models: building_graders/training/overview.md  # Coming soon

  - Running Graders:
      - Run Grading Tasks: running_graders/run_tasks.md
      - Grader Results Analysis: running_graders/grader_analysis.md

  - Validating Graders:
      - Overview: validating_graders/overview.md
      - Validate on RewardBench2: validating_graders/rewardbench2.md

  - Applications:
      - Zero-Shot Evaluation: applications/zero_shot_evaluation.md
      - Refine Data Quality: applications/data_refinement.md
      - Pairwise Model Evaluation: applications/select_rank.md

  - Integrations:
      - Langfuse: integrations/langfuse.md

  - Community:
      - Contribute to OpenJudge: community/contributing.md
      # - Documentation Style Guide: community/style-guide.md
      # - Animations Demo: community/animations-demo.md
plugins:
  - search:
      lang:
        - en
        - zh
      separator: '[\s\-\.\(\)\/]+'
      min_search_length: 2
      prebuild_index: true
      indexing: 'full'
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            members_order: source
            show_submodules: true
markdown_extensions:
  - admonition
  - footnotes
  - tables
  - extra
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.progressbar
  - pymdownx.snippets
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - shadcn.extensions.iconify

extra_css:
  - https://fonts.googleapis.com/css2?family=JetBrains+Mono:wght@400;500;600;700&display=swap
  - stylesheets/feature-cards.css
  - stylesheets/tabbed-code.css
  - stylesheets/readability-enhancements.css
  - stylesheets/code-enhancements.css
  - stylesheets/syntax-highlight.css
  - stylesheets/table-enhancements.css
  - stylesheets/jupyter-simple.css
  - stylesheets/nav-scroll-fix.css
  - stylesheets/workflow.css
  - stylesheets/animations.css
  - stylesheets/mermaid.css
  - stylesheets/mkdocstrings.css
  - stylesheets/responsive.css

extra_javascript:
  - javascripts/tabbed-code.js
  - javascripts/code-copy.js
  - javascripts/search-fix.js
  - javascripts/code-zoom.js
  - javascripts/nav-scroll-fix.js
  - javascripts/animations.js
  - javascripts/responsive.js