I’ve encountered this many times where I simply don’t understand the context and use of an API based of the API documentation unless I can find an example that already utilizes it in a working project. The first thing that comes to mind is Py Torch. I’ve tried to figure out how some API features work, or what they are doing in model loader code related to checkpoint caching but failed to contextualize. What harebrain details are obviously missing from someone who asks such a silly question?

  • grandma@sh.itjust.works
    link
    fedilink
    arrow-up
    4
    ·
    4 months ago

    If there’s no getting started section I usually go on GitHub to see how other projects use the library or API.

    Reading the API docs with no prior knowledge or context is hard unless they’re very well written.