search

microsoft / TypeChat

TypeChat is a library that makes it easy to build natural language interfaces using types.
https://microsoft.github.io/TypeChat/
MIT License
8.25k stars 391 forks source link

There's no Python specific documentation #244

Open gvanrossum opened 7 months ago

gvanrossum commented 7 months ago

In the README.md of the python subtree there's this sentence:

To learn more about TypeChat, visit the documentation which includes more information on TypeChat and how to get started.

However, the docs found at that link are exclusively aimed at a TypeScript audience, and give no specifics about e.g. how to write a schema in Python. I had to glean that from the examples, which is far from ideal. I had hoped for something like a Python version of Basic TypeScript Usage.

DanielRosenwasser commented 7 months ago

I put together https://github.com/microsoft/TypeChat/pull/237 a bit ago - it's not merged yet since the Python support is not yet published. But I guess I can merge it and just point out it's not yet published.

gvanrossum commented 7 months ago

I put together #237 a bit ago - it's not merged yet since the Python support is not yet published. But I guess I can merge it and just point out it's not yet published.

Oh, that would definitely have saved me a buch of headscratching and spelunking. :-) I just gave it a quick review. Maybe it needn't be linked from the "general" TypeChat front page until it's published, but it ought to be at least reachable from the Python-specific README.ml (which I used as my starting point).