Skip to content

Commit 8312afc

Browse files
actions-useractions-user
committed
docs: update codeboarding architecture documentation
## 📚 Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service. ### 📊 Summary - Documentation files created/updated: 6 - JSON files created/updated: 7 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .rst - Repository analyzed: https://github.com/CodeBoarding/ChatterBot - Destination: docs/architecture/ 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
1 parent 0d4224b commit 8312afc

6 files changed

Lines changed: 58 additions & 70 deletions

File tree

‎.codeboarding/LLM_Integration.json‎

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,7 @@
1111
"reference_start_line": 302,
1212
"reference_end_line": 310
1313
}
14-
],
15-
"assigned_files": [],
16-
"can_expand": false
14+
]
1715
},
1816
{
1917
"name": "Language Model Interface",
@@ -31,11 +29,7 @@
3129
"reference_start_line": null,
3230
"reference_end_line": null
3331
}
34-
],
35-
"assigned_files": [
36-
"chatterbot/llm.py"
37-
],
38-
"can_expand": false
32+
]
3933
},
4034
{
4135
"name": "Tool Executor",
@@ -53,9 +47,7 @@
5347
"reference_start_line": null,
5448
"reference_end_line": null
5549
}
56-
],
57-
"assigned_files": [],
58-
"can_expand": true
50+
]
5951
},
6052
{
6153
"name": "Response Formatter",
@@ -67,16 +59,12 @@
6759
"reference_start_line": null,
6860
"reference_end_line": null
6961
}
70-
],
71-
"assigned_files": [],
72-
"can_expand": false
62+
]
7363
},
7464
{
7565
"name": "Unclassified",
7666
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
77-
"referenced_source_code": [],
78-
"assigned_files": [],
79-
"can_expand": false
67+
"referenced_source_code": []
8068
}
8169
],
8270
"components_relations": [

‎.codeboarding/Logic_Response_Adapters.json‎

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,7 @@
1717
"reference_start_line": 10,
1818
"reference_end_line": 34
1919
}
20-
],
21-
"assigned_files": [
22-
"chatterbot/search.py",
23-
"chatterbot/logic/unit_conversion.py",
24-
"chatterbot/logic/mathematical_evaluation.py",
25-
"chatterbot/logic/logic_adapter.py",
26-
"chatterbot/logic/best_match.py",
27-
"chatterbot/logic/specific_response.py",
28-
"chatterbot/logic/time_adapter.py"
29-
],
30-
"can_expand": true
20+
]
3121
},
3222
{
3323
"name": "Response Selection",
@@ -39,11 +29,7 @@
3929
"reference_start_line": null,
4030
"reference_end_line": null
4131
}
42-
],
43-
"assigned_files": [
44-
"chatterbot/response_selection.py"
45-
],
46-
"can_expand": true
32+
]
4733
},
4834
{
4935
"name": "Comparisons",
@@ -73,21 +59,12 @@
7359
"reference_start_line": 122,
7460
"reference_end_line": 182
7561
}
76-
],
77-
"assigned_files": [
78-
"chatterbot/comparisons.py"
79-
],
80-
"can_expand": true
62+
]
8163
},
8264
{
8365
"name": "Unclassified",
8466
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
85-
"referenced_source_code": [],
86-
"assigned_files": [
87-
"chatterbot/vectorstores.py",
88-
"chatterbot/filters.py"
89-
],
90-
"can_expand": false
67+
"referenced_source_code": []
9168
}
9269
],
9370
"components_relations": [

‎.codeboarding/analysis.json‎

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313
}
1414
],
1515
"assigned_files": [
16+
"examples/basic_example.py",
17+
"examples/terminal_example.py",
18+
"examples/learning_feedback_example.py",
1619
"chatterbot/conversation.py",
1720
"chatterbot/components.py",
1821
"chatterbot/chatterbot.py"
@@ -43,10 +46,15 @@
4346
}
4447
],
4548
"assigned_files": [
49+
"examples/specific_response_example.py",
50+
"examples/math_and_time.py",
51+
"examples/convert_units.py",
52+
"examples/default_response_example.py",
4653
"chatterbot/search.py",
54+
"chatterbot/adapters.py",
4755
"chatterbot/response_selection.py",
56+
"chatterbot/tagging.py",
4857
"chatterbot/vectorstores.py",
49-
"chatterbot/filters.py",
5058
"chatterbot/comparisons.py",
5159
"chatterbot/logic/unit_conversion.py",
5260
"chatterbot/logic/mathematical_evaluation.py",
@@ -81,11 +89,22 @@
8189
}
8290
],
8391
"assigned_files": [
92+
"examples/training_example_chatterbot_corpus.py",
93+
"examples/terminal_mongo_example.py",
94+
"examples/tagged_dataset_example.py",
95+
"examples/memory_sql_example.py",
96+
"examples/training_example_list_data.py",
97+
"examples/training_example_ubuntu_corpus.py",
98+
"examples/export_example.py",
99+
"examples/django_example/django_example/management/commands/train.py",
84100
"chatterbot/corpus.py",
85101
"chatterbot/trainers.py",
86102
"chatterbot/ext/django_chatterbot/models.py",
87103
"chatterbot/ext/django_chatterbot/abstract_models.py",
104+
"chatterbot/ext/django_chatterbot/model_admin.py",
105+
"chatterbot/ext/django_chatterbot/admin.py",
88106
"chatterbot/ext/django_chatterbot/migrations/0014_remove_statement_extra_data.py",
107+
"chatterbot/ext/django_chatterbot/migrations/__init__.py",
89108
"chatterbot/ext/django_chatterbot/migrations/0005_statement_created_at.py",
90109
"chatterbot/ext/django_chatterbot/migrations/0011_blank_extra_data.py",
91110
"chatterbot/ext/django_chatterbot/migrations/0016_statement_stemmed_text.py",
@@ -132,9 +151,10 @@
132151
}
133152
],
134153
"assigned_files": [
135-
"chatterbot/tagging.py",
136154
"chatterbot/parsing.py",
137-
"chatterbot/preprocessors.py"
155+
"chatterbot/preprocessors.py",
156+
"chatterbot/filters.py",
157+
"chatterbot/languages.py"
138158
],
139159
"can_expand": true
140160
},
@@ -150,6 +170,8 @@
150170
}
151171
],
152172
"assigned_files": [
173+
"examples/openai_example.py",
174+
"examples/ollama_example.py",
153175
"chatterbot/llm.py"
154176
],
155177
"can_expand": true
@@ -159,24 +181,8 @@
159181
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
160182
"referenced_source_code": [],
161183
"assigned_files": [
162-
"examples/training_example_chatterbot_corpus.py",
163184
"examples/__init__.py",
164-
"examples/basic_example.py",
165-
"examples/terminal_example.py",
166-
"examples/terminal_mongo_example.py",
167-
"examples/specific_response_example.py",
168-
"examples/tagged_dataset_example.py",
169-
"examples/memory_sql_example.py",
170-
"examples/training_example_list_data.py",
171-
"examples/math_and_time.py",
172-
"examples/openai_example.py",
173-
"examples/training_example_ubuntu_corpus.py",
174-
"examples/convert_units.py",
175-
"examples/ollama_example.py",
176-
"examples/export_example.py",
177-
"examples/default_response_example.py",
178185
"examples/tkinter_gui.py",
179-
"examples/learning_feedback_example.py",
180186
"examples/django_example/manage.py",
181187
"examples/django_example/django_example/asgi.py",
182188
"examples/django_example/django_example/__init__.py",
@@ -186,24 +192,18 @@
186192
"examples/django_example/django_example/urls.py",
187193
"examples/django_example/django_example/management/__init__.py",
188194
"examples/django_example/django_example/management/commands/__init__.py",
189-
"examples/django_example/django_example/management/commands/train.py",
190195
"docs/conf.py",
191196
"docs/_ext/github.py",
192197
"docs/_ext/canonical.py",
193198
"chatterbot/__init__.py",
194-
"chatterbot/adapters.py",
195199
"chatterbot/__main__.py",
196200
"chatterbot/constants.py",
197201
"chatterbot/utils.py",
198202
"chatterbot/exceptions.py",
199-
"chatterbot/languages.py",
200203
"chatterbot/ext/__init__.py",
201204
"chatterbot/ext/django_chatterbot/__init__.py",
202205
"chatterbot/ext/django_chatterbot/apps.py",
203206
"chatterbot/ext/django_chatterbot/settings.py",
204-
"chatterbot/ext/django_chatterbot/model_admin.py",
205-
"chatterbot/ext/django_chatterbot/admin.py",
206-
"chatterbot/ext/django_chatterbot/migrations/__init__.py",
207207
"chatterbot/ext/sqlalchemy_app/__init__.py",
208208
"chatterbot/storage/__init__.py",
209209
"chatterbot/logic/__init__.py"
@@ -224,6 +224,13 @@
224224
"assigned_files": [],
225225
"can_expand": false
226226
},
227+
{
228+
"name": "Unclassified",
229+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
230+
"referenced_source_code": [],
231+
"assigned_files": [],
232+
"can_expand": false
233+
},
227234
{
228235
"name": "Unclassified",
229236
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",

‎.codeboarding/codeboarding_version.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"commit_hash": "8d77b37185f9f9ea313a90949b26d49389cab8b8",
2+
"commit_hash": "0d4224bec87befda44520e946a8a7244d3897801",
33
"code_boarding_version": "0.2.0"
44
}

‎.codeboarding/overview.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Overview
1313
Unclassified["Unclassified"]
1414
Unclassified["Unclassified"]
1515
Unclassified["Unclassified"]
16+
Unclassified["Unclassified"]
1617
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
1718
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
1819
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -128,3 +129,10 @@ Unclassified
128129
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
129130

130131
**Related Classes/Methods**: *None*
132+
133+
Unclassified
134+
^^^^^^^^^^^^
135+
136+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
137+
138+
**Related Classes/Methods**: *None*

‎docs/architecture/overview.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Overview
1313
Unclassified["Unclassified"]
1414
Unclassified["Unclassified"]
1515
Unclassified["Unclassified"]
16+
Unclassified["Unclassified"]
1617
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
1718
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
1819
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -128,3 +129,10 @@ Unclassified
128129
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
129130

130131
**Related Classes/Methods**: *None*
132+
133+
Unclassified
134+
^^^^^^^^^^^^
135+
136+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
137+
138+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)