Where to Find DiffSharp Installation Instructions, Tutorials, and API Documentation
Updated
DiffSharp's official site (diffsharp.github.io) is the central hub for all three: the Install and Getting Started / Quickstart pages cover setup, the Tutorials and More Examples pages provide runnable notebooks, and the API Documentation section holds the full API reference plus extension docs. The GitHub repository and BSD license details are linked from the same top-level navigation, so you can reach everything from the homepage without searching elsewhere.
Installation and first steps
Start from the homepage navigation, which lists Install, Getting Started, Quickstart, and Tutorials as separate entries.
- Install — the entry point for adding DiffSharp to a project.
- Getting Started and Quickstart — short walkthroughs that take you from a fresh setup to running tensor code.
- Tutorials — longer guided material that builds on the quickstart.
The site states DiffSharp is tested on Linux, macOS, and Windows, and that it supports CUDA and GPUs through its LibTorch backend. Those platform notes are the main compatibility facts to check before you begin; confirm current package and runtime requirements on the Install page itself rather than assuming them.
Tutorials and example notebooks
Two navigation entries serve this purpose: Tutorials and More Examples.
A practical detail from the site: all documentation pages are interactive notebooks you can execute directly in your browser without installing anything locally. That means you can try the tutorial code before committing to a local setup — useful if you want to evaluate the API first. The site also notes support for Jupyter and Visual Studio Code notebooks for local work.
The homepage includes an Example section, so the shortest path to seeing real DiffSharp code is the homepage example, then Tutorials, then More Examples.
API reference and extensions
The API Documentation section contains:
- API Reference — the full reference for the library's functions and types.
- Extensions — documentation for extension packages.
One navigation aid worth knowing: the DiffSharp API is designed to be similar to the PyTorch Python API through similar naming and idioms, and the site says that where elements share names, the PyTorch documentation can generally be used as a guide. So when the DiffSharp reference is thin on a particular operation, the equivalent PyTorch page is a reasonable companion.
GitHub, license, and source
The top navigation links GitHub and License (BSD). The project describes itself as 100% open source under the BSD license, so the repository is where you go for source code, issues, and release history. The site does not state pricing or login requirements for any of these resources; treat access terms as something to confirm on the pages themselves.
Which resource to open first
| Your goal | Go to |
|---|---|
| Set up DiffSharp locally | Install, then Getting Started / Quickstart |
| Try code with no local install | Any documentation page (runs in-browser), or Tutorials |
| Learn by worked examples | Homepage Example, then Tutorials, then More Examples |
| Look up a function or type | API Reference |
| Use extension packages | Extensions |
| Read source, report issues, check license | GitHub and License (BSD) links |
If you are new to the library, the efficient order is: run the homepage example in the browser, read Quickstart, then set up locally via Install. If you already have a working environment and need a specific operation, skip straight to the API Reference and use the PyTorch docs as a cross-reference for similarly named elements.