-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
157 lines (148 loc) · 5.05 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
site_name: "prompto: An open source library for asynchronous querying of LLM endpoints"
dev_addr: "127.0.0.1:8088"
docs_dir: .
nav:
- Home: README.md
- Documentation Guide: docs/README.md
- Examples:
- Examples: examples/README.md
- Running experiments with prompto: examples/notebooks/running_experiments.ipynb
- Specifying rate limits: examples/notebooks/grouping_prompts_and_specifying_rate_limits.ipynb
- System Demonstration:
- Introduction: examples/system-demo/README.md
- Obtaining sample prompts for system demonstration examples: examples/system-demo/alpaca_sample_generation.ipynb
- Experiment 1: examples/system-demo/experiment_1.ipynb
- Experiment 2: examples/system-demo/experiment_2.ipynb
- Experiment 3: examples/system-demo/experiment_3.ipynb
- Using prompto for evaluation:
- Notebook: examples/evaluation/running_llm_as_judge_experiment.ipynb
- Notebook: examples/evaluation/running_experiments_with_custom_evaluations.ipynb
- Notebook: examples/evaluation/rephrase_prompts.ipynb
- Azure OpenAI:
- Example: examples/azure-openai/README.md
- Notebook: examples/azure-openai/azure-openai.ipynb
- Multimodal: examples/azure-openai/azure-openai-multimodal.ipynb
- OpenAI:
- Example: examples/openai/README.md
- Notebook: examples/openai/openai.ipynb
- Multimodal: examples/openai/openai-multimodal.ipynb
- Anthropic:
- Example: examples/anthropic/README.md
- Notebook: examples/anthropic/anthropic.ipynb
- Multimodal: examples/anthropic/anthropic-multimodal.ipynb
- Gemini:
- Example: examples/gemini/README.md
- Notebook: examples/gemini/gemini.ipynb
- Multimodal: examples/gemini/gemini-multimodal.ipynb
- Vertex AI:
- Example: examples/vertexai/README.md
- Notebook: examples/vertexai/vertexai.ipynb
- Multimodal: examples/vertexai/vertexai-multimodal.ipynb
- Ollama:
- Example: examples/ollama/README.md
- Notebook: examples/ollama/ollama.ipynb
- Using prompto:
- Setting up an experiment file: docs/experiment_file.md
- Configuring environment variables: docs/environment_variables.md
- Running experiments and the pipeline: docs/pipeline.md
- prompto commands: docs/commands.md
- Specifying rate limits: docs/rate_limits.md
- Rephrasing prompts: docs/rephrasals.md
- Using prompto for evaluation: docs/evaluation.md
- Implemented APIs:
- APIs overview: docs/models.md
- Azure OpenAI: docs/azure_openai.md
- OpenAI: docs/openai.md
- Anthropic: docs/anthropic.md
- Gemini: docs/gemini.md
- Vertex AI: docs/vertexai.md
- Ollama: docs/ollama.md
- Huggingface text-generation-inference: docs/huggingface_tgi.md
- Simple quart API: docs/quart.md
- Contributing to prompto:
- Adding new API/model: docs/add_new_api.md
- Contribution guide: docs/contribution.md
- API Reference: reference/
- Issues: https://github.com/alan-turing-institute/prompto/issues
- About: docs/about.md
- License: LICENSE.md
repo_url: https://github.com/alan-turing-institute/prompto/
watch:
- docs
theme:
name: material
features:
- content.code.copy
- content.tabs.link
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
plugins:
- search:
lang: en
- same-dir
# optional
# - include-markdown
# - markdown-exec
- gen-files:
scripts:
- docs/gen_ref_pages.py
- literate-nav:
nav_file: DOC_STRINGS.md
- section-index
- autorefs
- mkdocs-jupyter:
include: ["*.ipynb"]
- mkdocstrings:
handlers:
python:
paths: [.]
options:
docstring_style: numpy
separate_signature: true
show_signature_annotations: true
annotations_path: brief
line_length: 80
signature_crossrefs: true
merge_init_into_classes: true
markdown_extensions:
- smarty
- admonition
- pymdownx.details
- abbr
- attr_list
- def_list
- tables
- footnotes
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.arithmatex:
generic: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
anchor_linenums: true
use_pygments: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.magiclink
# extra_css:
# - css/code_select.css