New AI Help Tool

[briantoby]

Thanks to Pawan Tripathy, GSAS-II has a new LLM-based tool for finding information about GSAS-II, Query-GSAS-II. This has now been included in GSAS-II.

The way this works is that an LLM-based index is created from all the GSAS-II documentation:

• the GSAS-II home pages,
• the GSAS-II help files,
• the GSAS-II tutorials
• my draft textbook
• the developer's documentation

This is a lot of material, ~500,000 words. Since this documentation gets updated fairly frequently, the index will be rebuilt weekly (eventually). You can create the index yourself, but given that the build takes over an hour, it is faster to download.

The Query-GSAS-II application provides few different ways to ask questions in plain English and get footnoted answers to the question referencing the documentation, but the implementation inside GSAS-II only offers a window for this, as below:

This window is opened with the "Help via LLM Docs Search" command in Help. The first time this is used, GSAS-II will guide you through the process of downloading files and installing packages to make this work. Note that in the example above, I asked about "settings" and the LLM was able to associate this with "configuration variables," as they are described in the docs. It located some now out-of-date documentation on file config.py, which is no longer used, so I need to update that.