Skip to content

Commit ef48575

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 bc45286 commit ef48575

4 files changed

Lines changed: 49 additions & 26 deletions

File tree

‎.codeboarding/analysis.json‎

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,7 @@
1313
}
1414
],
1515
"assigned_files": [
16-
"examples/basic_example.py",
17-
"examples/terminal_example.py",
18-
"examples/terminal_mongo_example.py",
19-
"examples/learning_feedback_example.py",
20-
"examples/django_example/django_example/views.py",
2116
"chatterbot/conversation.py",
22-
"chatterbot/components.py",
2317
"chatterbot/chatterbot.py"
2418
],
2519
"can_expand": true
@@ -48,15 +42,13 @@
4842
}
4943
],
5044
"assigned_files": [
51-
"examples/specific_response_example.py",
52-
"examples/math_and_time.py",
53-
"examples/convert_units.py",
54-
"examples/default_response_example.py",
5545
"chatterbot/search.py",
46+
"chatterbot/adapters.py",
5647
"chatterbot/response_selection.py",
5748
"chatterbot/filters.py",
5849
"chatterbot/comparisons.py",
5950
"chatterbot/logic/unit_conversion.py",
51+
"chatterbot/logic/__init__.py",
6052
"chatterbot/logic/mathematical_evaluation.py",
6153
"chatterbot/logic/logic_adapter.py",
6254
"chatterbot/logic/best_match.py",
@@ -89,19 +81,12 @@
8981
}
9082
],
9183
"assigned_files": [
92-
"examples/training_example_chatterbot_corpus.py",
93-
"examples/tagged_dataset_example.py",
94-
"examples/memory_sql_example.py",
95-
"examples/training_example_list_data.py",
96-
"examples/training_example_ubuntu_corpus.py",
97-
"examples/export_example.py",
98-
"examples/django_example/django_example/management/commands/train.py",
9984
"chatterbot/corpus.py",
100-
"chatterbot/vectorstores.py",
10185
"chatterbot/trainers.py",
10286
"chatterbot/ext/django_chatterbot/models.py",
10387
"chatterbot/ext/django_chatterbot/abstract_models.py",
10488
"chatterbot/ext/django_chatterbot/migrations/0014_remove_statement_extra_data.py",
89+
"chatterbot/ext/django_chatterbot/migrations/__init__.py",
10590
"chatterbot/ext/django_chatterbot/migrations/0005_statement_created_at.py",
10691
"chatterbot/ext/django_chatterbot/migrations/0011_blank_extra_data.py",
10792
"chatterbot/ext/django_chatterbot/migrations/0016_statement_stemmed_text.py",
@@ -123,6 +108,7 @@
123108
"chatterbot/ext/django_chatterbot/migrations/0017_tags_unique.py",
124109
"chatterbot/ext/sqlalchemy_app/models.py",
125110
"chatterbot/storage/storage_adapter.py",
111+
"chatterbot/storage/__init__.py",
126112
"chatterbot/storage/mongodb.py",
127113
"chatterbot/storage/redis.py",
128114
"chatterbot/storage/sql_storage.py",
@@ -167,8 +153,7 @@
167153
}
168154
],
169155
"assigned_files": [
170-
"examples/openai_example.py",
171-
"examples/ollama_example.py",
156+
"chatterbot/vectorstores.py",
172157
"chatterbot/llm.py"
173158
],
174159
"can_expand": true
@@ -178,35 +163,50 @@
178163
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
179164
"referenced_source_code": [],
180165
"assigned_files": [
166+
"examples/training_example_chatterbot_corpus.py",
181167
"examples/__init__.py",
168+
"examples/basic_example.py",
169+
"examples/terminal_example.py",
170+
"examples/terminal_mongo_example.py",
171+
"examples/specific_response_example.py",
172+
"examples/tagged_dataset_example.py",
173+
"examples/memory_sql_example.py",
174+
"examples/training_example_list_data.py",
175+
"examples/math_and_time.py",
176+
"examples/openai_example.py",
177+
"examples/training_example_ubuntu_corpus.py",
178+
"examples/convert_units.py",
179+
"examples/ollama_example.py",
180+
"examples/export_example.py",
181+
"examples/default_response_example.py",
182182
"examples/tkinter_gui.py",
183+
"examples/learning_feedback_example.py",
183184
"examples/django_example/manage.py",
184185
"examples/django_example/django_example/asgi.py",
185186
"examples/django_example/django_example/__init__.py",
186187
"examples/django_example/django_example/settings.py",
188+
"examples/django_example/django_example/views.py",
187189
"examples/django_example/django_example/wsgi.py",
188190
"examples/django_example/django_example/urls.py",
189191
"examples/django_example/django_example/management/__init__.py",
190192
"examples/django_example/django_example/management/commands/__init__.py",
193+
"examples/django_example/django_example/management/commands/train.py",
191194
"docs/conf.py",
192195
"docs/_ext/github.py",
193196
"docs/_ext/canonical.py",
194197
"chatterbot/__init__.py",
195-
"chatterbot/adapters.py",
196198
"chatterbot/__main__.py",
197199
"chatterbot/constants.py",
198200
"chatterbot/utils.py",
201+
"chatterbot/components.py",
199202
"chatterbot/exceptions.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",
204207
"chatterbot/ext/django_chatterbot/model_admin.py",
205208
"chatterbot/ext/django_chatterbot/admin.py",
206-
"chatterbot/ext/django_chatterbot/migrations/__init__.py",
207-
"chatterbot/ext/sqlalchemy_app/__init__.py",
208-
"chatterbot/storage/__init__.py",
209-
"chatterbot/logic/__init__.py"
209+
"chatterbot/ext/sqlalchemy_app/__init__.py"
210210
],
211211
"can_expand": false
212212
},
@@ -259,6 +259,13 @@
259259
"assigned_files": [],
260260
"can_expand": false
261261
},
262+
{
263+
"name": "Unclassified",
264+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
265+
"referenced_source_code": [],
266+
"assigned_files": [],
267+
"can_expand": false
268+
},
262269
{
263270
"name": "Unclassified",
264271
"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": "9a1f81bea435c0b84fb8639c22a51af95457f526",
2+
"commit_hash": "bc452866a4fde16feb9b4e6141f9ae2596f30afa",
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
@@ -18,6 +18,7 @@ Overview
1818
Unclassified["Unclassified"]
1919
Unclassified["Unclassified"]
2020
Unclassified["Unclassified"]
21+
Unclassified["Unclassified"]
2122
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
2223
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
2324
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -168,3 +169,10 @@ Unclassified
168169
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
169170

170171
**Related Classes/Methods**: *None*
172+
173+
Unclassified
174+
^^^^^^^^^^^^
175+
176+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
177+
178+
**Related Classes/Methods**: *None*

‎docs/architecture/overview.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Overview
1818
Unclassified["Unclassified"]
1919
Unclassified["Unclassified"]
2020
Unclassified["Unclassified"]
21+
Unclassified["Unclassified"]
2122
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
2223
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
2324
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -168,3 +169,10 @@ Unclassified
168169
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
169170

170171
**Related Classes/Methods**: *None*
172+
173+
Unclassified
174+
^^^^^^^^^^^^
175+
176+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
177+
178+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)