Markdown CHANGELOG for LLM assistance

[xpe]

The burn releases HTML page is well-done.

I would really appreciate the same information formatted as a CHANGELOG, as described by the "keep a changelog" website. (Did I overlook a change log in the burn source code?)

Why? LLM ingest

Why am I asking for the information in Markdown format? I want to provide a burn change log to my favorite LLM. Using a Markdown file is more feasible to input into a LLM context window.

HTML to Markdown Conversion

Yes, one can convert the GitHub releases page to Markdown in at least two ways:

• use a LLM
• use a tool such as rhysd's changelog-from-release

However this is done, doing such a conversion once, at the repo level, would allow all of us to share it.

Inspiration

The Squiggle Language has documentation on how setup LLM's for coding assistance for Squiggle itself. This approach could be useful for burn too.

[xpe]

Using the very-easy-to-use rhysd's changelog-from-release, I generated a burn CHANGELOG:

• Gist for viewing : burn-CHANGELOG-v0.15.0.md
• Attachment for downloading : CHANGELOG.md

[xpe]

Here is how I use it. I include the CHANGELOG.md using the Zed editor's include functionality; e.g. /file burn-CHANGELOG.md. Then I write:

Me: Please use the change log above to update your knowledge about the Rust-based burn ML library. No need for analysis or commentary. Later, I will ask some specific questions.

Here is a typical response:

Assistant: I have read through the detailed change log for the burn ML library. I now have updated knowledge about the library's evolution from v0.3.0 through v0.15.0, including major features, breaking changes, bug fixes, and improvements across areas like tensor operations, neural networks, ONNX support, backends, documentation, and infrastructure. I'm ready to answer any specific questions you may have about the library's development and capabilities.

[nathanielsimard]

Is the changelog just the concatenation of all the release notes? For LLMs you could also generate the git commit history, which would give more context.