Skip to content

Commit d093a11

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 8312afc commit d093a11

File tree

4 files changed

+52
-29
lines changed

4 files changed

+52
-29
lines changed

‎.codeboarding/analysis.json‎

Lines changed: 35 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,8 @@
1313
}
1414
],
1515
"assigned_files": [
16-
"examples/basic_example.py",
17-
"examples/terminal_example.py",
18-
"examples/learning_feedback_example.py",
16+
"chatterbot/__init__.py",
17+
"chatterbot/__main__.py",
1918
"chatterbot/conversation.py",
2019
"chatterbot/components.py",
2120
"chatterbot/chatterbot.py"
@@ -46,17 +45,14 @@
4645
}
4746
],
4847
"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",
5348
"chatterbot/search.py",
5449
"chatterbot/adapters.py",
5550
"chatterbot/response_selection.py",
5651
"chatterbot/tagging.py",
57-
"chatterbot/vectorstores.py",
52+
"chatterbot/filters.py",
5853
"chatterbot/comparisons.py",
5954
"chatterbot/logic/unit_conversion.py",
55+
"chatterbot/logic/__init__.py",
6056
"chatterbot/logic/mathematical_evaluation.py",
6157
"chatterbot/logic/logic_adapter.py",
6258
"chatterbot/logic/best_match.py",
@@ -89,18 +85,14 @@
8985
}
9086
],
9187
"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",
10088
"chatterbot/corpus.py",
89+
"chatterbot/vectorstores.py",
10190
"chatterbot/trainers.py",
91+
"chatterbot/ext/django_chatterbot/__init__.py",
92+
"chatterbot/ext/django_chatterbot/apps.py",
10293
"chatterbot/ext/django_chatterbot/models.py",
10394
"chatterbot/ext/django_chatterbot/abstract_models.py",
95+
"chatterbot/ext/django_chatterbot/settings.py",
10496
"chatterbot/ext/django_chatterbot/model_admin.py",
10597
"chatterbot/ext/django_chatterbot/admin.py",
10698
"chatterbot/ext/django_chatterbot/migrations/0014_remove_statement_extra_data.py",
@@ -124,8 +116,10 @@
124116
"chatterbot/ext/django_chatterbot/migrations/0006_create_conversation.py",
125117
"chatterbot/ext/django_chatterbot/migrations/0007_response_created_at.py",
126118
"chatterbot/ext/django_chatterbot/migrations/0017_tags_unique.py",
119+
"chatterbot/ext/sqlalchemy_app/__init__.py",
127120
"chatterbot/ext/sqlalchemy_app/models.py",
128121
"chatterbot/storage/storage_adapter.py",
122+
"chatterbot/storage/__init__.py",
129123
"chatterbot/storage/mongodb.py",
130124
"chatterbot/storage/redis.py",
131125
"chatterbot/storage/sql_storage.py",
@@ -153,7 +147,6 @@
153147
"assigned_files": [
154148
"chatterbot/parsing.py",
155149
"chatterbot/preprocessors.py",
156-
"chatterbot/filters.py",
157150
"chatterbot/languages.py"
158151
],
159152
"can_expand": true
@@ -170,8 +163,6 @@
170163
}
171164
],
172165
"assigned_files": [
173-
"examples/openai_example.py",
174-
"examples/ollama_example.py",
175166
"chatterbot/llm.py"
176167
],
177168
"can_expand": true
@@ -181,8 +172,24 @@
181172
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
182173
"referenced_source_code": [],
183174
"assigned_files": [
175+
"examples/training_example_chatterbot_corpus.py",
184176
"examples/__init__.py",
177+
"examples/basic_example.py",
178+
"examples/terminal_example.py",
179+
"examples/terminal_mongo_example.py",
180+
"examples/specific_response_example.py",
181+
"examples/tagged_dataset_example.py",
182+
"examples/memory_sql_example.py",
183+
"examples/training_example_list_data.py",
184+
"examples/math_and_time.py",
185+
"examples/openai_example.py",
186+
"examples/training_example_ubuntu_corpus.py",
187+
"examples/convert_units.py",
188+
"examples/ollama_example.py",
189+
"examples/export_example.py",
190+
"examples/default_response_example.py",
185191
"examples/tkinter_gui.py",
192+
"examples/learning_feedback_example.py",
186193
"examples/django_example/manage.py",
187194
"examples/django_example/django_example/asgi.py",
188195
"examples/django_example/django_example/__init__.py",
@@ -192,21 +199,14 @@
192199
"examples/django_example/django_example/urls.py",
193200
"examples/django_example/django_example/management/__init__.py",
194201
"examples/django_example/django_example/management/commands/__init__.py",
202+
"examples/django_example/django_example/management/commands/train.py",
195203
"docs/conf.py",
196204
"docs/_ext/github.py",
197205
"docs/_ext/canonical.py",
198-
"chatterbot/__init__.py",
199-
"chatterbot/__main__.py",
200206
"chatterbot/constants.py",
201207
"chatterbot/utils.py",
202208
"chatterbot/exceptions.py",
203-
"chatterbot/ext/__init__.py",
204-
"chatterbot/ext/django_chatterbot/__init__.py",
205-
"chatterbot/ext/django_chatterbot/apps.py",
206-
"chatterbot/ext/django_chatterbot/settings.py",
207-
"chatterbot/ext/sqlalchemy_app/__init__.py",
208-
"chatterbot/storage/__init__.py",
209-
"chatterbot/logic/__init__.py"
209+
"chatterbot/ext/__init__.py"
210210
],
211211
"can_expand": false
212212
},
@@ -231,6 +231,13 @@
231231
"assigned_files": [],
232232
"can_expand": false
233233
},
234+
{
235+
"name": "Unclassified",
236+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
237+
"referenced_source_code": [],
238+
"assigned_files": [],
239+
"can_expand": false
240+
},
234241
{
235242
"name": "Unclassified",
236243
"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": "0d4224bec87befda44520e946a8a7244d3897801",
2+
"commit_hash": "8312afcbb7a5e9fc2fd4670efa9f6cb092b14ef3",
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
@@ -14,6 +14,7 @@ Overview
1414
Unclassified["Unclassified"]
1515
Unclassified["Unclassified"]
1616
Unclassified["Unclassified"]
17+
Unclassified["Unclassified"]
1718
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
1819
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
1920
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -136,3 +137,10 @@ Unclassified
136137
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
137138

138139
**Related Classes/Methods**: *None*
140+
141+
Unclassified
142+
^^^^^^^^^^^^
143+
144+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
145+
146+
**Related Classes/Methods**: *None*

‎docs/architecture/overview.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Overview
1414
Unclassified["Unclassified"]
1515
Unclassified["Unclassified"]
1616
Unclassified["Unclassified"]
17+
Unclassified["Unclassified"]
1718
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
1819
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
1920
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -136,3 +137,10 @@ Unclassified
136137
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
137138

138139
**Related Classes/Methods**: *None*
140+
141+
Unclassified
142+
^^^^^^^^^^^^
143+
144+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
145+
146+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)