Skip to content

Commit dc0d78b

Browse files
committed
Describe how to generate class diagram.
Add a comment to the markdown to explain how the class diagram was generated, so that it can be updated as more teleprompters are added.
1 parent 33ea790 commit dc0d78b

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/docs/building-blocks/6-optimizers.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ In many cases, we found that compiling leads to better prompts than human writin
3232

3333
## What DSPy Optimizers are currently available?
3434

35+
<!-- The following diagram was generated by: -->
36+
<!-- 1. Running symilar on the teleprompter module to extract the python hierarchy as a Graphviz dot file -->
37+
<!-- 2. Hand-editing the resulting dot file to remove classes that are not teleprompters/optimizers (e.g., classes for data structures manipulated by optimizers). -->
38+
<!-- 3. Using dot to compile the `.dot` file into a PNG -->
39+
3540
[Subclasses of Teleprompter](figures/teleprompter-classes.png)
3641

3742
All of these can be accessed via `from dspy.teleprompt import *`.

0 commit comments

Comments
 (0)