Migrate docs from Sphinx to MkDocs (#18145)

Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
This commit is contained in:
Harry Mellor
2025-05-23 02:09:53 -07:00
committed by GitHub
parent d0bc2f810b
commit a1fe24d961
218 changed files with 4126 additions and 6790 deletions
+2 -3
View File
@@ -11,9 +11,8 @@ MULTIMODAL_REGISTRY = MultiModalRegistry()
The global {class}`~MultiModalRegistry` is used by model runners to
dispatch data processing according to the target model.
:::{seealso}
{ref}`mm-processing`
:::
Info:
{ref}`mm-processing`
"""
__all__ = [
+9 -13
View File
@@ -289,9 +289,8 @@ class BaseMultiModalField(ABC):
@dataclass(frozen=True)
class MultiModalBatchedField(BaseMultiModalField):
"""
:::{seealso}
{func}`MultiModalFieldConfig.batched`
:::
Info:
[MultiModalFieldConfig.batched][]
"""
def build_elems(
@@ -320,10 +319,9 @@ class MultiModalBatchedField(BaseMultiModalField):
@dataclass(frozen=True)
class MultiModalFlatField(BaseMultiModalField):
"""
:::{seealso}
{func}`MultiModalFieldConfig.flat`
{func}`MultiModalFieldConfig.flat_from_sizes`
:::
Info:
[MultiModalFieldConfig.flat][]
[MultiModalFieldConfig.flat_from_sizes][]
"""
slices: Union[Sequence[slice], Sequence[Sequence[slice]]]
dim: int = 0
@@ -363,9 +361,8 @@ class MultiModalFlatField(BaseMultiModalField):
@dataclass(frozen=True)
class MultiModalSharedField(BaseMultiModalField):
"""
:::{seealso}
{func}`MultiModalFieldConfig.shared`
:::
Info:
[MultiModalFieldConfig.shared][]
"""
batch_size: int
@@ -510,9 +507,8 @@ class MultiModalFieldConfig:
Element 3: [[C],[C]]
```
:::{seealso}
{func}`MultiModalFieldConfig.flat`
:::
Info:
[MultiModalFieldConfig.flat][]
"""
if size_per_item.ndim != 1:
+4 -6
View File
@@ -214,9 +214,8 @@ class MultiModalRegistry:
When the model receives multi-modal data, the provided function is
invoked to transform the data into a dictionary of model inputs.
:::{seealso}
{ref}`mm-processing`
:::
Info:
{ref}`mm-processing`
"""
def wrapper(model_cls: N) -> N:
@@ -260,9 +259,8 @@ class MultiModalRegistry:
"""
Create a multi-modal processor for a specific model and tokenizer.
:::{seealso}
{ref}`mm-processing`
:::
Info:
{ref}`mm-processing`
"""
if not model_config.is_multimodal_model:
raise ValueError(f"{model_config.model} is not a multimodal model")