Skip to content

Commit d18ea58

Browse files
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 88813a8 commit d18ea58

File tree

4 files changed

+78
-55
lines changed

4 files changed

+78
-55
lines changed

.codeboarding/analysis.json

Lines changed: 61 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,6 @@
1313
}
1414
],
1515
"assigned_files": [
16-
"chatterbot/__init__.py",
17-
"chatterbot/__main__.py",
18-
"chatterbot/conversation.py",
19-
"chatterbot/components.py",
2016
"chatterbot/chatterbot.py"
2117
],
2218
"can_expand": true
@@ -45,18 +41,15 @@
4541
}
4642
],
4743
"assigned_files": [
48-
"chatterbot/search.py",
49-
"chatterbot/adapters.py",
50-
"chatterbot/response_selection.py",
51-
"chatterbot/filters.py",
52-
"chatterbot/comparisons.py",
5344
"chatterbot/logic/unit_conversion.py",
5445
"chatterbot/logic/__init__.py",
5546
"chatterbot/logic/mathematical_evaluation.py",
56-
"chatterbot/logic/logic_adapter.py",
5747
"chatterbot/logic/best_match.py",
5848
"chatterbot/logic/specific_response.py",
59-
"chatterbot/logic/time_adapter.py"
49+
"chatterbot/logic/time_adapter.py",
50+
"chatterbot/comparisons.py",
51+
"chatterbot/response_selection.py",
52+
"chatterbot/logic/logic_adapter.py"
6053
],
6154
"can_expand": true
6255
},
@@ -84,39 +77,14 @@
8477
}
8578
],
8679
"assigned_files": [
87-
"chatterbot/corpus.py",
88-
"chatterbot/vectorstores.py",
89-
"chatterbot/trainers.py",
90-
"chatterbot/ext/django_chatterbot/models.py",
91-
"chatterbot/ext/django_chatterbot/abstract_models.py",
92-
"chatterbot/ext/django_chatterbot/migrations/0014_remove_statement_extra_data.py",
93-
"chatterbot/ext/django_chatterbot/migrations/__init__.py",
94-
"chatterbot/ext/django_chatterbot/migrations/0005_statement_created_at.py",
95-
"chatterbot/ext/django_chatterbot/migrations/0011_blank_extra_data.py",
96-
"chatterbot/ext/django_chatterbot/migrations/0016_statement_stemmed_text.py",
97-
"chatterbot/ext/django_chatterbot/migrations/0020_alter_statement_conversation_and_more.py",
98-
"chatterbot/ext/django_chatterbot/migrations/0019_alter_statement_id_alter_tag_id_and_more.py",
99-
"chatterbot/ext/django_chatterbot/migrations/0018_text_max_length.py",
100-
"chatterbot/ext/django_chatterbot/migrations/0002_statement_extra_data.py",
101-
"chatterbot/ext/django_chatterbot/migrations/0003_change_occurrence_default.py",
102-
"chatterbot/ext/django_chatterbot/migrations/0001_initial.py",
103-
"chatterbot/ext/django_chatterbot/migrations/0010_statement_text.py",
104-
"chatterbot/ext/django_chatterbot/migrations/0004_rename_in_response_to.py",
105-
"chatterbot/ext/django_chatterbot/migrations/0012_statement_created_at.py",
106-
"chatterbot/ext/django_chatterbot/migrations/0009_tags.py",
107-
"chatterbot/ext/django_chatterbot/migrations/0008_update_conversations.py",
108-
"chatterbot/ext/django_chatterbot/migrations/0015_statement_persona.py",
109-
"chatterbot/ext/django_chatterbot/migrations/0013_change_conversations.py",
110-
"chatterbot/ext/django_chatterbot/migrations/0006_create_conversation.py",
111-
"chatterbot/ext/django_chatterbot/migrations/0007_response_created_at.py",
112-
"chatterbot/ext/django_chatterbot/migrations/0017_tags_unique.py",
113-
"chatterbot/ext/sqlalchemy_app/models.py",
114-
"chatterbot/storage/storage_adapter.py",
11580
"chatterbot/storage/__init__.py",
11681
"chatterbot/storage/mongodb.py",
11782
"chatterbot/storage/redis.py",
11883
"chatterbot/storage/sql_storage.py",
119-
"chatterbot/storage/django_storage.py"
84+
"chatterbot/storage/django_storage.py",
85+
"chatterbot/corpus.py",
86+
"chatterbot/trainers.py",
87+
"chatterbot/storage/storage_adapter.py"
12088
],
12189
"can_expand": true
12290
},
@@ -138,10 +106,8 @@
138106
}
139107
],
140108
"assigned_files": [
141-
"chatterbot/tagging.py",
142-
"chatterbot/parsing.py",
143109
"chatterbot/preprocessors.py",
144-
"chatterbot/languages.py"
110+
"chatterbot/parsing.py"
145111
],
146112
"can_expand": true
147113
},
@@ -166,6 +132,50 @@
166132
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
167133
"referenced_source_code": [],
168134
"assigned_files": [
135+
"chatterbot/adapters.py",
136+
"chatterbot/search.py",
137+
"chatterbot/__init__.py",
138+
"chatterbot/__main__.py",
139+
"chatterbot/constants.py",
140+
"chatterbot/tagging.py",
141+
"chatterbot/conversation.py",
142+
"chatterbot/vectorstores.py",
143+
"chatterbot/utils.py",
144+
"chatterbot/components.py",
145+
"chatterbot/filters.py",
146+
"chatterbot/exceptions.py",
147+
"chatterbot/languages.py",
148+
"chatterbot/ext/__init__.py",
149+
"chatterbot/ext/django_chatterbot/__init__.py",
150+
"chatterbot/ext/django_chatterbot/apps.py",
151+
"chatterbot/ext/django_chatterbot/models.py",
152+
"chatterbot/ext/django_chatterbot/abstract_models.py",
153+
"chatterbot/ext/django_chatterbot/settings.py",
154+
"chatterbot/ext/django_chatterbot/model_admin.py",
155+
"chatterbot/ext/django_chatterbot/admin.py",
156+
"chatterbot/ext/django_chatterbot/migrations/0014_remove_statement_extra_data.py",
157+
"chatterbot/ext/django_chatterbot/migrations/__init__.py",
158+
"chatterbot/ext/django_chatterbot/migrations/0005_statement_created_at.py",
159+
"chatterbot/ext/django_chatterbot/migrations/0011_blank_extra_data.py",
160+
"chatterbot/ext/django_chatterbot/migrations/0016_statement_stemmed_text.py",
161+
"chatterbot/ext/django_chatterbot/migrations/0020_alter_statement_conversation_and_more.py",
162+
"chatterbot/ext/django_chatterbot/migrations/0019_alter_statement_id_alter_tag_id_and_more.py",
163+
"chatterbot/ext/django_chatterbot/migrations/0018_text_max_length.py",
164+
"chatterbot/ext/django_chatterbot/migrations/0002_statement_extra_data.py",
165+
"chatterbot/ext/django_chatterbot/migrations/0003_change_occurrence_default.py",
166+
"chatterbot/ext/django_chatterbot/migrations/0001_initial.py",
167+
"chatterbot/ext/django_chatterbot/migrations/0010_statement_text.py",
168+
"chatterbot/ext/django_chatterbot/migrations/0004_rename_in_response_to.py",
169+
"chatterbot/ext/django_chatterbot/migrations/0012_statement_created_at.py",
170+
"chatterbot/ext/django_chatterbot/migrations/0009_tags.py",
171+
"chatterbot/ext/django_chatterbot/migrations/0008_update_conversations.py",
172+
"chatterbot/ext/django_chatterbot/migrations/0015_statement_persona.py",
173+
"chatterbot/ext/django_chatterbot/migrations/0013_change_conversations.py",
174+
"chatterbot/ext/django_chatterbot/migrations/0006_create_conversation.py",
175+
"chatterbot/ext/django_chatterbot/migrations/0007_response_created_at.py",
176+
"chatterbot/ext/django_chatterbot/migrations/0017_tags_unique.py",
177+
"chatterbot/ext/sqlalchemy_app/__init__.py",
178+
"chatterbot/ext/sqlalchemy_app/models.py",
169179
"examples/training_example_chatterbot_corpus.py",
170180
"examples/__init__.py",
171181
"examples/basic_example.py",
@@ -196,17 +206,7 @@
196206
"examples/django_example/django_example/management/commands/train.py",
197207
"docs/conf.py",
198208
"docs/_ext/github.py",
199-
"docs/_ext/canonical.py",
200-
"chatterbot/constants.py",
201-
"chatterbot/utils.py",
202-
"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/django_chatterbot/model_admin.py",
208-
"chatterbot/ext/django_chatterbot/admin.py",
209-
"chatterbot/ext/sqlalchemy_app/__init__.py"
209+
"docs/_ext/canonical.py"
210210
],
211211
"can_expand": false
212212
},
@@ -287,6 +287,13 @@
287287
"assigned_files": [],
288288
"can_expand": false
289289
},
290+
{
291+
"name": "Unclassified",
292+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
293+
"referenced_source_code": [],
294+
"assigned_files": [],
295+
"can_expand": false
296+
},
290297
{
291298
"name": "Unclassified",
292299
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"commit_hash": "7a3d6201a3632c825c6bf3a7cf9eb6c9472d829a",
2+
"commit_hash": "88813a8cb799b34bf686041a5d3a91ba95f861cd",
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
@@ -22,6 +22,7 @@ Overview
2222
Unclassified["Unclassified"]
2323
Unclassified["Unclassified"]
2424
Unclassified["Unclassified"]
25+
Unclassified["Unclassified"]
2526
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
2627
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
2728
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -200,3 +201,10 @@ Unclassified
200201
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
201202

202203
**Related Classes/Methods**: *None*
204+
205+
Unclassified
206+
^^^^^^^^^^^^
207+
208+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
209+
210+
**Related Classes/Methods**: *None*

docs/architecture/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Overview
2222
Unclassified["Unclassified"]
2323
Unclassified["Unclassified"]
2424
Unclassified["Unclassified"]
25+
Unclassified["Unclassified"]
2526
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
2627
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
2728
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -200,3 +201,10 @@ Unclassified
200201
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
201202

202203
**Related Classes/Methods**: *None*
204+
205+
Unclassified
206+
^^^^^^^^^^^^
207+
208+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
209+
210+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)