refiners/mkdocs.yml

104 lines
2.9 KiB
YAML
Raw Permalink Normal View History

2024-01-09 10:50:37 +00:00
site_name: Refiners
2024-01-30 08:35:25 +00:00
site_description: A micro framework on top of PyTorch with first class citizen APIs for foundation model adaptation
2024-01-09 10:50:37 +00:00
repo_name: Refiners
repo_url: https://github.com/finegrain-ai/refiners
edit_uri: edit/main/docs/
copyright: © Lagon Technologies
2024-01-08 15:22:04 +00:00
theme:
favicon: assets/favicon.svg
logo: assets/favicon.svg
2024-01-08 15:22:04 +00:00
name: material
custom_dir: docs/overrides
palette:
primary: deep orange
accent: deep orange
features:
- navigation.tabs
- navigation.sections
- navigation.top
- navigation.tracking
- navigation.expand
- navigation.path
- toc.follow
- navigation.tabs.sticky
- content.code.copy
- announce.dismiss
plugins:
- search
- tags
2024-01-31 18:11:34 +00:00
- literate-nav:
nav_file: SUMMARY.md
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://pytorch.org/docs/master/objects.inv
- https://docs.kidger.site/jaxtyping/objects.inv
2024-01-31 18:11:34 +00:00
options:
show_bases: true
show_source: true
show_root_toc_entry: false
show_symbol_type_heading: true
show_symbol_type_toc: true
show_if_no_docstring: false
filters:
- "!^_"
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
separate_signature: true
show_signature_annotations: true
signature_crossrefs: true
watch:
- src/refiners
extra_css:
- stylesheets/extra.css
nav:
- Home:
2024-02-02 09:48:15 +00:00
- Welcome: index.md
- Manifesto: home/why.md
2024-01-31 17:18:26 +00:00
- Getting started:
2024-02-01 17:32:05 +00:00
- getting-started/recommended.md
- getting-started/advanced.md
2024-01-31 17:18:26 +00:00
- Key Concepts:
2024-01-31 11:44:43 +00:00
- concepts/chain.md
- concepts/context.md
- concepts/adapter/index.md
- Guides:
- Adapting SDXL: guides/adapting_sdxl/index.md
2024-01-31 17:18:26 +00:00
- API Reference:
2024-01-31 18:11:34 +00:00
- Refiners: reference/
extra:
social:
- icon: fontawesome/brands/discord
link: https://discord.gg/mCmjNUVV7d
- icon: fontawesome/brands/github
link: https://github.com/finegrain-ai/refiners
- icon: fontawesome/brands/twitter
link: https://twitter.com/finegrain_ai
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/finegrain-ai/
markdown_extensions:
- admonition
- attr_list
- footnotes
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.details
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- toc:
2024-01-31 17:18:26 +00:00
permalink: true
validation:
links:
absolute_links: info # use relative_to_docs when we switch to mkdocs 1.6