Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding an /llms.txt file for OPTIMADE #534

Open
ml-evs opened this issue Nov 16, 2024 · 0 comments
Open

Adding an /llms.txt file for OPTIMADE #534

ml-evs opened this issue Nov 16, 2024 · 0 comments

Comments

@ml-evs
Copy link
Member

ml-evs commented Nov 16, 2024

/llms.txt (https://github.com/AnswerDotAI/llms-txt) is an attempt to standardize the way in which APIs and libraries can describe themselves so that LLM agents can make the best use of them, especially when such libraries are changing more frequently than the training sets of the LLMs themselves. It can be used in the same manner as robots.txt on a website, like a documentation site or specification.

I think this would be worthwhile for us to add for OPTIMADE, and it could be encouraged that individual providers either link to it, or host their own versions too. One some other projects, I have also found that this kind of description also meshes quite nicely with what a beginner would want to see, so we can maybe kill two birds with one stone by writing a brief user guide for OPTIMADE that can double up as an llms.txt.

Relatedly, one thing that I am often asked for is examples for OPTIMADE queries. Given that this /llms.txt format should probably also include such a set of examples, we could consider adding these as a separate document or as part of the specification, which can then be directly copied into the /llms.txt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant