fireflyframework-datascience/mkdocs.yml at main · fireflyframework/fireflyframework-datascience · 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
site_name: Firefly DataScience
site_description: AutoML that fuses GenAI with classical ML & Deep Learning — built on Firefly Agentic.
site_url: https://fireflyframework.github.io/fireflyframework-datascience/
repo_url: https://github.com/fireflyframework/fireflyframework-datascience
repo_name: fireflyframework/fireflyframework-datascience
copyright: Copyright 2026 Firefly Software Foundation · Apache-2.0
docs_dir: docs
# Flat .html URLs (not directory URLs) so relative image paths in raw HTML (<img src="img/...">)
# resolve from the site root on every page — fixes diagrams not rendering on GitHub Pages.
use_directory_urls: false

theme:
  name: material
  logo: img/logo.svg
  favicon: img/favicon.svg
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: cyan
      accent: cyan
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: cyan
      accent: cyan
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - search.suggest
    - search.highlight
    - search.share
    - toc.follow
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.keys
  - footnotes

plugins:
  - search

extra_css:
  - stylesheets/firefly.css

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/fireflyframework/fireflyframework-datascience
      name: Firefly DataScience on GitHub
    - icon: material/rocket-launch-outline
      link: https://github.com/fireflyframework/fireflyframework-agentic
      name: Firefly Agentic — the GenAI substrate
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/fireflyframework-datascience/
      name: fireflyframework-datascience on PyPI

nav:
  - Home: index.md
  - Getting started:
      - Quick Start: quickstart.md
      - Tutorial: tutorial.md
      - Samples: samples.md
      - Configuration: configuration.md
      - Configuring the LLM: llm-configuration.md
  - Concepts:
      - Architecture: architecture.md
      - Datasets: datasets.md
      - Classical AutoML: automl.md
      - Explainability: explainability.md
      - GenAI Feature Engineering: genai-features.md
      - Agentic ML-Engineering Loop: agentic-loop.md
      - Deep Learning & TabFM: deep-learning.md
      - Serving & Lineage: serving.md
      - Security Model: security.md
      - Benchmarks: benchmarks.md
  - Use case — Lumen: use-case-lumen.md

# README.md is the GitHub folder index (table of contents); index.md is the site home. Keep the
# former in the repo but exclude it (and the local-only specs) from the built site.
exclude_docs: |
  README.md
  superpowers/