Skip to content

Commit bc45286

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 9a1f81b commit bc45286

File tree

4 files changed

+50
-27
lines changed

4 files changed

+50
-27
lines changed

‎.codeboarding/analysis.json‎

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@
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",
1621
"chatterbot/conversation.py",
1722
"chatterbot/components.py",
1823
"chatterbot/chatterbot.py"
@@ -43,8 +48,13 @@
4348
}
4449
],
4550
"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",
4655
"chatterbot/search.py",
4756
"chatterbot/response_selection.py",
57+
"chatterbot/filters.py",
4858
"chatterbot/comparisons.py",
4959
"chatterbot/logic/unit_conversion.py",
5060
"chatterbot/logic/mathematical_evaluation.py",
@@ -79,18 +89,19 @@
7989
}
8090
],
8191
"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",
8299
"chatterbot/corpus.py",
83100
"chatterbot/vectorstores.py",
84101
"chatterbot/trainers.py",
85-
"chatterbot/ext/django_chatterbot/__init__.py",
86-
"chatterbot/ext/django_chatterbot/apps.py",
87102
"chatterbot/ext/django_chatterbot/models.py",
88103
"chatterbot/ext/django_chatterbot/abstract_models.py",
89-
"chatterbot/ext/django_chatterbot/settings.py",
90-
"chatterbot/ext/django_chatterbot/model_admin.py",
91-
"chatterbot/ext/django_chatterbot/admin.py",
92104
"chatterbot/ext/django_chatterbot/migrations/0014_remove_statement_extra_data.py",
93-
"chatterbot/ext/django_chatterbot/migrations/__init__.py",
94105
"chatterbot/ext/django_chatterbot/migrations/0005_statement_created_at.py",
95106
"chatterbot/ext/django_chatterbot/migrations/0011_blank_extra_data.py",
96107
"chatterbot/ext/django_chatterbot/migrations/0016_statement_stemmed_text.py",
@@ -110,7 +121,6 @@
110121
"chatterbot/ext/django_chatterbot/migrations/0006_create_conversation.py",
111122
"chatterbot/ext/django_chatterbot/migrations/0007_response_created_at.py",
112123
"chatterbot/ext/django_chatterbot/migrations/0017_tags_unique.py",
113-
"chatterbot/ext/sqlalchemy_app/__init__.py",
114124
"chatterbot/ext/sqlalchemy_app/models.py",
115125
"chatterbot/storage/storage_adapter.py",
116126
"chatterbot/storage/mongodb.py",
@@ -141,7 +151,6 @@
141151
"chatterbot/tagging.py",
142152
"chatterbot/parsing.py",
143153
"chatterbot/preprocessors.py",
144-
"chatterbot/filters.py",
145154
"chatterbot/languages.py"
146155
],
147156
"can_expand": true
@@ -158,6 +167,8 @@
158167
}
159168
],
160169
"assigned_files": [
170+
"examples/openai_example.py",
171+
"examples/ollama_example.py",
161172
"chatterbot/llm.py"
162173
],
163174
"can_expand": true
@@ -167,34 +178,16 @@
167178
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
168179
"referenced_source_code": [],
169180
"assigned_files": [
170-
"examples/training_example_chatterbot_corpus.py",
171181
"examples/__init__.py",
172-
"examples/basic_example.py",
173-
"examples/terminal_example.py",
174-
"examples/terminal_mongo_example.py",
175-
"examples/specific_response_example.py",
176-
"examples/tagged_dataset_example.py",
177-
"examples/memory_sql_example.py",
178-
"examples/training_example_list_data.py",
179-
"examples/math_and_time.py",
180-
"examples/openai_example.py",
181-
"examples/training_example_ubuntu_corpus.py",
182-
"examples/convert_units.py",
183-
"examples/ollama_example.py",
184-
"examples/export_example.py",
185-
"examples/default_response_example.py",
186182
"examples/tkinter_gui.py",
187-
"examples/learning_feedback_example.py",
188183
"examples/django_example/manage.py",
189184
"examples/django_example/django_example/asgi.py",
190185
"examples/django_example/django_example/__init__.py",
191186
"examples/django_example/django_example/settings.py",
192-
"examples/django_example/django_example/views.py",
193187
"examples/django_example/django_example/wsgi.py",
194188
"examples/django_example/django_example/urls.py",
195189
"examples/django_example/django_example/management/__init__.py",
196190
"examples/django_example/django_example/management/commands/__init__.py",
197-
"examples/django_example/django_example/management/commands/train.py",
198191
"docs/conf.py",
199192
"docs/_ext/github.py",
200193
"docs/_ext/canonical.py",
@@ -205,6 +198,13 @@
205198
"chatterbot/utils.py",
206199
"chatterbot/exceptions.py",
207200
"chatterbot/ext/__init__.py",
201+
"chatterbot/ext/django_chatterbot/__init__.py",
202+
"chatterbot/ext/django_chatterbot/apps.py",
203+
"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",
207+
"chatterbot/ext/sqlalchemy_app/__init__.py",
208208
"chatterbot/storage/__init__.py",
209209
"chatterbot/logic/__init__.py"
210210
],
@@ -252,6 +252,13 @@
252252
"assigned_files": [],
253253
"can_expand": false
254254
},
255+
{
256+
"name": "Unclassified",
257+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
258+
"referenced_source_code": [],
259+
"assigned_files": [],
260+
"can_expand": false
261+
},
255262
{
256263
"name": "Unclassified",
257264
"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": "f0b5efed524714332709c11fabdcc24e87ccf090",
2+
"commit_hash": "9a1f81bea435c0b84fb8639c22a51af95457f526",
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
@@ -17,6 +17,7 @@ Overview
1717
Unclassified["Unclassified"]
1818
Unclassified["Unclassified"]
1919
Unclassified["Unclassified"]
20+
Unclassified["Unclassified"]
2021
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
2122
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
2223
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -160,3 +161,10 @@ Unclassified
160161
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
161162

162163
**Related Classes/Methods**: *None*
164+
165+
Unclassified
166+
^^^^^^^^^^^^
167+
168+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
169+
170+
**Related Classes/Methods**: *None*

‎docs/architecture/overview.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Overview
1717
Unclassified["Unclassified"]
1818
Unclassified["Unclassified"]
1919
Unclassified["Unclassified"]
20+
Unclassified["Unclassified"]
2021
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
2122
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
2223
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -160,3 +161,10 @@ Unclassified
160161
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
161162

162163
**Related Classes/Methods**: *None*
164+
165+
Unclassified
166+
^^^^^^^^^^^^
167+
168+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
169+
170+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)