forked from fetchai/agents-aea
-
Notifications
You must be signed in to change notification settings - Fork 15
/
mkdocs.yml
318 lines (311 loc) · 14 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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
site_name: open-aea
site_url: https://open-aea.docs.autonolas.tech/
site_description: Everything you need to know about (open) AEAs.
repo_url: https://github.com/valory-xyz/open-aea
site_author: developer@fetch.ai,info@valory.xyz
edit_uri: edit/main/docs/
theme:
name: 'material'
feature:
tabs: true
strict: true
nav:
- Introduction: 'index.md'
- Version: 'version.md'
- Upgrading: 'upgrading.md'
- Concepts:
- Agent-oriented development: 'agent-oriented-development.md'
- Vision: 'vision.md'
- Application areas: 'app-areas.md'
- Identity: 'identity.md'
- Trust minimisation: 'trust.md'
- Language Agnostic Definition: 'language-agnostic-definition.md'
- Agent & component registry: 'registry.md'
- Demos:
- Demos: 'demos.md'
- Echo Demo: 'echo_demo.md'
- HTTP Echo Demo: 'http-echo-demo.md'
- Gym skill: 'gym-skill.md'
- Configure with Environment Variables: 'aev-echo-demo.md'
- Development - Beginner:
- AEA quick start: 'quickstart.md'
- Core components - Part 1: 'core-components-1.md'
- AEA and web frameworks: 'aea-vs-mvc.md'
- Core components - Part 2: 'core-components-2.md'
- How AEAs talk to each other - interaction protocols: 'interaction-protocol.md'
- Development setup: 'development-setup.md'
- Logging: 'logging.md'
- Debugging: 'debug.md'
- Development - Intermediate:
- Developing New Components:
- Ways to build an AEA: 'step-one.md'
- Build an AEA with the CLI: 'build-aea-step-by-step.md'
- Scaffolding packages: 'scaffolding.md'
- Generating protocols: 'protocol-generator.md'
- Developing contracts: 'creating-contracts.md'
- Architecture & component deep-dives:
- Design principles: 'design-principles.md'
- Architectural diagram: 'diagram.md'
- Connections: 'connection.md'
- Protocols: 'protocol.md'
- Skills: 'skill.md'
- Contracts: 'contract.md'
- Decision Maker: 'decision-maker.md'
- Ledger & Crypto APIs: 'ledger-integration.md'
- Message routing: 'message-routing.md'
- Configurations: 'config.md'
- Working with overrides: 'overrides.md'
- Limitations of v1: 'limits.md'
- Use Case:
- Front-end intergration: 'connect-a-frontend.md'
- HTTP Connection: 'http-connection-and-skill.md'
- Build an AEA on a Raspberry Pi: 'raspberry-set-up.md'
- Development - Advanced:
- Topic Guides:
- Generic Storage: 'generic-storage.md'
- Multi agent manager: 'multi-agent-manager.md'
- Use multiplexer stand-alone: 'multiplexer-standalone.md'
- Create stand-alone transaction: 'standalone-transaction.md'
- Create decision-maker transaction: 'decision-maker-transaction.md'
- Testing Skills: 'skill-testing.md'
- Deployment: 'deployment.md'
- 12-Factor app and AEAs: '12-factor.md'
- Known limitations: 'known-limits.md'
- Build an AEA programmatically: 'build-aea-programmatically.md'
- AEAs vs agents: 'agent-vs-aea.md'
- Modes of running an AEA: 'modes.md'
- Profiling: 'runtime-cost.md'
- Proof of Representation: 'por.md'
- Security: 'security.md'
- Agent Communication:
- Agent Communication Network: 'acn.md'
- ACN Connections: 'p2p-connection.md'
- ACN Internals: 'acn-internals.md'
- Developer Interfaces:
- CLI:
- Installation: 'cli-how-to.md'
- Commands: 'cli-commands.md'
- File structure: 'package-imports.md'
- Generating wealth: 'wealth.md'
- Benchmarks:
- Performance benchmark: 'performance-benchmark.md'
- API:
- AbstractAgent: 'api/abstract_agent.md'
- AEA: 'api/aea.md'
- AEA Builder: 'api/aea_builder.md'
- Agent: 'api/agent.md'
- Agent Loop: 'api/agent_loop.md'
- Common: 'api/common.md'
- Exceptions: 'api/exceptions.md'
- Launcher: 'api/launcher.md'
- Multiplexer: 'api/multiplexer.md'
- Runner: 'api/runner.md'
- Runtime: 'api/runtime.md'
- Components:
- Base: 'api/components/base.md'
- Loader: 'api/components/loader.md'
- Utils: 'api/components/utils.md'
- Configurations:
- Base: 'api/configurations/base.md'
- Constants: 'api/configurations/constants.md'
- Data Types: 'api/configurations/data_types.md'
- Loader: 'api/configurations/loader.md'
- Manager: 'api/configurations/manager.md'
- Pypi: 'api/configurations/pypi.md'
- Utils: 'api/configurations/utils.md'
- Validation: 'api/configurations/validation.md'
- Connections:
- Base: 'api/connections/base.md'
- Context: 'api/context/base.md'
- Contracts:
- Base: 'api/contracts/base.md'
- Crypto:
- Base: 'api/crypto/base.md'
- Helpers: 'api/crypto/helpers.md'
- LedgerApis: 'api/crypto/ledger_apis.md'
- Plugin: 'api/crypto/plugin.md'
- Wallet: 'api/crypto/wallet.md'
- Registries:
- Base: 'api/crypto/registries/base.md'
- Decision Maker:
- Base: 'api/decision_maker/base.md'
- Default: 'api/decision_maker/default.md'
- Error Handler:
- Base: 'api/error_handler/base.md'
- Default: 'api/error_handler/default.md'
- Helpers:
- ACN:
- Agent Record: 'api/helpers/acn/agent_record.md'
- URI: 'api/helpers/acn/uri.md'
- Async Friendly Queue: 'api/helpers/async_friendly_queue.md'
- Async Utils: 'api/helpers/async_utils.md'
- Base: 'api/helpers/base.md'
- Constants: 'api/helpers/constants.md'
- CID: 'api/helpers/cid.md'
- Dependency Tree: 'api/helpers/dependency_tree.md'
- Env Vars: 'api/helpers/env_vars.md'
- Exception Policy: 'api/helpers/exception_policy.md'
- Exec Timeout: 'api/helpers/exec_timeout.md'
- File IO: 'api/helpers/file_io.md'
- File Lock: 'api/helpers/file_lock.md'
- Git: api/helpers/git.md
- HttpRequests: 'api/helpers/http_requests.md'
- Install Dependency: 'api/helpers/install_dependency.md'
- IO: 'api/helpers/io.md'
- IPFS:
- Base: 'api/helpers/ipfs/base.md'
- Utils: 'api/helpers/ipfs/utils.md'
- Fingerprinting: api/helpers/fingerprint.md
- Logging: 'api/helpers/logging.md'
- MultiAddress:
- Base: 'api/helpers/multiaddr/base.md'
- MultipleExecutor: 'api/helpers/multiple_executor.md'
- Pipe: 'api/helpers/pipe.md'
- Preferences:
- Base: 'api/helpers/preference_representations/base.md'
- Profiler Type Blacklist: api/helpers/profiler_type_black_list.md
- Protocol Helpers: api/helpers/protocols.md
- Profiling: 'api/helpers/profiling.md'
- Search:
- Generic: 'api/helpers/search/generic.md'
- Models: 'api/helpers/search/models.md'
- Serializers: 'api/helpers/serializers.md'
- Storage:
- GenericStorage: 'api/helpers/storage/generic_storage.md'
- Backends:
- Base: 'api/helpers/storage/backends/base.md'
- Sqlite: 'api/helpers/storage/backends/sqlite.md'
- Sym Link: 'api/helpers/sym_link.md'
- Transaction:
- Base: 'api/helpers/transaction/base.md'
- Win32: 'api/helpers/win32.md'
- YamlUtils: 'api/helpers/yaml_utils.md'
- Identity: 'api/identity/base.md'
- Mail: 'api/mail/base.md'
- Manager:
- Manager: 'api/manager/manager.md'
- Project: 'api/manager/project.md'
- Helpers: api/manager/helpers.md
- Utils: 'api/manager/utils.md'
- Package Manager:
- Base: 'api/package_manager/base.md'
- Package Manager V0: 'api/package_manager/v0.md'
- Package Manager V1: 'api/package_manager/v1.md'
- Protocols:
- Base: 'api/protocols/base.md'
- Dialogue:
- Base: 'api/protocols/dialogue/base.md'
- Generator:
- Base: 'api/protocols/generator/base.md'
- Common: 'api/protocols/generator/common.md'
- Extract Specification: 'api/protocols/generator/extract_specification.md'
- Validate: 'api/protocols/generator/validate.md'
- Signing Protocol:
- Custom Types: 'api/protocols/signing/custom_types.md'
- Dialogues: 'api/protocols/signing/dialogues.md'
- Message: 'api/protocols/signing/message.md'
- Serialization: 'api/protocols/signing/serialization.md'
- Test: 'api/protocols/signing/tests/test_signing.md'
- Registries:
- Base: 'api/registries/base.md'
- Filter: 'api/registries/filter.md'
- Resources: 'api/registries/resources.md'
- Skills:
- Base: 'api/skills/base.md'
- Behaviors: 'api/skills/behaviours.md'
- Task: 'api/skills/tasks.md'
- Test Tools:
- Constants: 'api/test_tools/constants.md'
- Exceptions: 'api/test_tools/exceptions.md'
- Generic: 'api/test_tools/generic.md'
- Test Cases: 'api/test_tools/test_cases.md'
- Test Contract: 'api/test_tools/test_contract.md'
- Test Skill: 'api/test_tools/test_skill.md'
- Docker Image : api/test_tools/docker_image.md
- Mocks : api/test_tools/mocks.md
- Network : api/test_tools/network.md
- Utils : api/test_tools/utils.md
- Plugins:
- CLI:
- IPFS:
- API: 'api/plugins/aea_cli_ipfs/core.md'
- Exceptions: 'api/plugins/aea_cli_ipfs/exceptions.md'
- Registry: 'api/plugins/aea_cli_ipfs/registry.md'
- Utils: 'api/plugins/aea_cli_ipfs/ipfs_utils.md'
- Test Tools: 'api/plugins/aea_cli_ipfs/test_tools/fixture_helpers.md'
- Benchmark:
- Core: api/plugins/aea_cli_benchmark/core.md
- Utils: api/plugins/aea_cli_benchmark/utils.md
- Cases:
- ACN Communication:
- Base: api/plugins/aea_cli_benchmark/case_acn_communication/case.md
- Command: api/plugins/aea_cli_benchmark/case_acn_communication/command.md
- Utils: api/plugins/aea_cli_benchmark/case_acn_communication/utils.md
- ACN Startup:
- Base: api/plugins/aea_cli_benchmark/case_acn_startup/case.md
- Command: api/plugins/aea_cli_benchmark/case_acn_startup/command.md
- Utils: api/plugins/aea_cli_benchmark/case_acn_startup/utils.md
- Agent Construction:
- Base: api/plugins/aea_cli_benchmark/case_agent_construction_time/case.md
- Command: api/plugins/aea_cli_benchmark/case_agent_construction_time/command.md
- Decision Maker:
- Base: api/plugins/aea_cli_benchmark/case_decision_maker/case.md
- Command: api/plugins/aea_cli_benchmark/case_decision_maker/command.md
- Dialogues Memory Usage:
- Base: api/plugins/aea_cli_benchmark/case_dialogues_memory_usage/case.md
- Command: api/plugins/aea_cli_benchmark/case_dialogues_memory_usage/command.md
- Memory Usage:
- Base: api/plugins/aea_cli_benchmark/case_mem_usage/case.md
- Command: api/plugins/aea_cli_benchmark/case_mem_usage/command.md
- Messages Memory Usage:
- Base: api/plugins/aea_cli_benchmark/case_messages_memory_usage/case.md
- Command: api/plugins/aea_cli_benchmark/case_messages_memory_usage/command.md
- Multiagent:
- Base: api/plugins/aea_cli_benchmark/case_multiagent/case.md
- Command: api/plugins/aea_cli_benchmark/case_multiagent/command.md
- Multiagent HTTP Dialogues:
- Base: api/plugins/aea_cli_benchmark/case_multiagent_http_dialogues/case.md
- Command: api/plugins/aea_cli_benchmark/case_multiagent_http_dialogues/command.md
- Proactive:
- Base: api/plugins/aea_cli_benchmark/case_proactive/case.md
- Command: api/plugins/aea_cli_benchmark/case_proactive/command.md
- Reactive:
- Base: api/plugins/aea_cli_benchmark/case_reactive/case.md
- Command: api/plugins/aea_cli_benchmark/case_reactive/command.md
- Transaction Generation:
- Base: api/plugins/aea_cli_benchmark/case_tx_generate/case.md
- Core: api/plugins/aea_cli_benchmark/case_tx_generate/core.md
- Command: api/plugins/aea_cli_benchmark/case_tx_generate/command.md
- Dialogues: api/plugins/aea_cli_benchmark/case_tx_generate/dialogues.md
- Docker Image: api/plugins/aea_cli_benchmark/case_tx_generate/docker_image.md
- Legder Utils: api/plugins/aea_cli_benchmark/case_tx_generate/ledger_utils.md
- Ledger:
- Cosmos:
- API: 'api/plugins/aea_ledger_cosmos/cosmos.md'
- HashFuncs: 'api/plugins/aea_ledger_cosmos/hashfuncs.md'
- Ethereum:
- API: 'api/plugins/aea_ledger_ethereum/ethereum.md'
- Constants: api/plugins/aea_ledger_ethereum/test_tools/constants.md
- Docker Images: api/plugins/aea_ledger_ethereum/test_tools/docker_images.md
- Fixture Helpers: api/plugins/aea_ledger_ethereum/test_tools/fixture_helpers.md
- Fetchai:
- API: 'api/plugins/aea_ledger_fetchai/fetchai.md'
- Constants: api/plugins/aea_ledger_fetchai/test_tools/constants.md
- Docker Images: api/plugins/aea_ledger_fetchai/test_tools/docker_images.md
- HashFuncs: 'api/plugins/aea_ledger_fetchai/hashfuncs.md'
- Registries:
- IPFS: ipfs_registry.md
- Package list: 'package_list.md'
- Glossary: 'glossary.md'
- FAQ: 'faq.md'
plugins:
- markdownmermaid
- search
markdown_extensions:
- pymdownx.superfences
- pymdownx.highlight
- admonition
extra_css:
- stylesheets/extra.css
extra_javascript:
- https://unpkg.com/mermaid@8.10.1/dist/mermaid.min.js