Add Long-form API documentation #53
Conversation
|
Currently building at https://cambridge-iccs.github.io/FTorch/ |
|
Suggestions for additional pages:
It was also suggested that we reduce the README to make it more manageable whilst maintaining the key content there. |
|
Can this close #5? |
|
According to https://forddocs.readthedocs.io/en/latest/user_guide/writing_documentation.html#non-fortran-source-files we should be able to use FORD for the C code. Not sure how well it works though |
|
Indeed, I am looking at this locally and will push once I have something. It could close #5 and we should certainly document the C, but we have discussed since that was opened that we are 'branding' as a Fortran API rather than a 'Fortran and C' API since C users will likely know what they are doing with binding to C++. |
|
(Mostly a note for myself) In the GPU section, it might be worth adding something about moving non- parameters/buffers to GPU, as I intend to do in Cambridge-ICCS/FTorch-benchmarks#27. |
I have added a GPU page - feel free to add to it - maybe on a branch if we want to be safe and then merge back into here. |
|
As discussed offline, perhaps we could work towards getting this PR merged and open new issues for the remaining checklist items? The content here is already a really good starting point. I'd be happy to review this PR if that'd be helpful? |
Yes, please do! |
There was a problem hiding this comment.
This is a really great start - lots of useful content, the FORD setup seems to work well, and the webpage looks nice. I checked all the links I came across and all worked except one (see comments).
Most of my requests are fairly minor and I'd be happy to help resolving them, if that would be useful?
I wonder if something like 'User guide' might be a better heading than 'Other documentation'? Just because there's lots of useful information in there.
…rom this branch for now.
…ows instructions.
…and links to worked examples.
…icipation of merging.
|
Thanks @jwallwork23 I think those points are all covered in recent commits, including the moving 'Other docs' to 'User Guide'. Also updated the landing page with latest resources and modified the workflow for After casting an eye over I think this is probably now good to go subject to a re-review. |
|
This will also now close #98 as I have removed/simplified large chunks of the README to point at the online documentation. |
There was a problem hiding this comment.
Thanks very much for making these changes @jatkinson1000! The docs are now a great source of info for getting started, as well as covering some more advanced topics.
My only final request is very minor (see the unresolved thread above) so I'm happy to approve.
* Add docs gh workflow. * Add basif FTorch.md for FORD. * Update docs workflow to build site on branch. * Update docs workflow to build site on branch. * Update docs workflow to have different branch names. * Add additional page drafts to docs. * Add to documentation - slides, license, cmake. * Restructure other docs. * Add transpose docs [WIP]. * Add transpose docs [WIP]. * Update docs workflow following review by @jwallwork23. Still builds from this branch for now. * Update install docs following review by @jwallwork23 and clarify Windows instructions. * Update docs page on transposition of data and torch_tensor_from_array/blob. * Move 'Other Documentation' to 'User Guide'. * Update empty examples page with generic example from the main README and links to worked examples. * Update main page with latest talks and projects. * Update workflow to build docs for main rather than this branch in anticipation of merging. * Prune README by linking to online documentation. * Minor updates to README for TOC and typos. * Add Fortran snippet to top of README to showcase FTorch. * Consisten spelling of CMake and FTorch in examples.
Add long form API documentation using FORD: https://cambridge-iccs.github.io/FTorch/
Will close #20