Skip to content

Exposing documentation to docs.rs #3958

@aaelony

Description

@aaelony

if I check https://docs.rs/burn/latest/burn/, I read about lots of tantalizing things Burn can do, but I can't drill down and learn more. I can search for Dataset but nothing comes up. "Data" shows results, https://docs.rs/burn/latest/burn/?search=Data, but not necessarily how to connect my own local dataset via local file directory or SQL query or other means.

However, if I go to the Burn source, I see what I am looking for in things like https://github.com/tracel-ai/burn/blob/main/crates/burn-dataset/src/dataset/dataframe.rs where I can see nice examples like ‎tests::create_test_dataframe‎ https://github.com/tracel-ai/burn/blob/main/crates/burn-dataset/src/dataset/dataframe.rs#L272-L288.

If I know the Burn Book exists, I can find https://github.com/tracel-ai/burn/blob/main/burn-book/src/building-blocks/dataset.md .

Should these be surfaced such that they can be found from docs.rs?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions