From 60edca6909cac7c1082ccfc29bb35b4fc6ce3379 Mon Sep 17 00:00:00 2001 From: Shroominic Date: Sat, 27 Jan 2024 12:54:18 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20update=20todos?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/todo.md | 35 +++++++++++++++++++++++++++++++++++ roadmap.todo | 6 +++--- 2 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 docs/todo.md diff --git a/docs/todo.md b/docs/todo.md new file mode 100644 index 0000000..ab209d3 --- /dev/null +++ b/docs/todo.md @@ -0,0 +1,35 @@ +# TODOs for writing the documentation + +- [ ] convert MODELS.md into a seperate docs page + +- [ ] explaination for important examples + +- [ ] features breakdown + +- [ ] list all different output types/parsers + +- [ ] list all different input argument types + +- [ ] section about prompt writing and jinja syntax + examples how prompts are compiled + +- [ ] langchain compatibility explanation and examples + +- [ ] async/await explanation and examples + +- [ ] explaination of codebase structure and how to contribute + +- [ ] bounties/todos for contributors + +- [ ] union types/ error handling + +- [ ] page about local models (llamacpp/ollama) + +- [ ] document vision support + +- [ ] how to scale/structure a complex codebase using funcchain + +- [ ] funcchain settings + +- [ ] streaming support and examples + +- [ ] explain signature schema diff --git a/roadmap.todo b/roadmap.todo index 16ebb60..76a702a 100644 --- a/roadmap.todo +++ b/roadmap.todo @@ -1,8 +1,8 @@ -IMPORTANT: +IMPORTANT NOW: [ ] - enable union type without function calling (6h) [ ] - improve docs (8h) -COMING SOON: +TODO: [ ] - pydantic model streaming (6h) @@ -33,4 +33,4 @@ COMING SOON: [ ] - FuncUnion and str output (6h) -[ ] - think of new syntax for special dspy modules (COT, FewShot, ...) \ No newline at end of file +[ ] - think of new syntax for special dspy modules (COT, FewShot, ...)