Skip to content

Commit 5e800eb

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 d18ea58 commit 5e800eb

4 files changed

Lines changed: 78 additions & 55 deletions

File tree

.codeboarding/analysis.json

Lines changed: 61 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313
}
1414
],
1515
"assigned_files": [
16+
"chatterbot/__init__.py",
17+
"chatterbot/__main__.py",
18+
"chatterbot/conversation.py",
19+
"chatterbot/components.py",
1620
"chatterbot/chatterbot.py"
1721
],
1822
"can_expand": true
@@ -41,15 +45,17 @@
4145
}
4246
],
4347
"assigned_files": [
48+
"chatterbot/search.py",
49+
"chatterbot/response_selection.py",
50+
"chatterbot/filters.py",
51+
"chatterbot/comparisons.py",
4452
"chatterbot/logic/unit_conversion.py",
4553
"chatterbot/logic/__init__.py",
4654
"chatterbot/logic/mathematical_evaluation.py",
55+
"chatterbot/logic/logic_adapter.py",
4756
"chatterbot/logic/best_match.py",
4857
"chatterbot/logic/specific_response.py",
49-
"chatterbot/logic/time_adapter.py",
50-
"chatterbot/comparisons.py",
51-
"chatterbot/response_selection.py",
52-
"chatterbot/logic/logic_adapter.py"
58+
"chatterbot/logic/time_adapter.py"
5359
],
5460
"can_expand": true
5561
},
@@ -77,14 +83,45 @@
7783
}
7884
],
7985
"assigned_files": [
86+
"chatterbot/corpus.py",
87+
"chatterbot/vectorstores.py",
88+
"chatterbot/trainers.py",
89+
"chatterbot/ext/django_chatterbot/__init__.py",
90+
"chatterbot/ext/django_chatterbot/apps.py",
91+
"chatterbot/ext/django_chatterbot/models.py",
92+
"chatterbot/ext/django_chatterbot/abstract_models.py",
93+
"chatterbot/ext/django_chatterbot/settings.py",
94+
"chatterbot/ext/django_chatterbot/model_admin.py",
95+
"chatterbot/ext/django_chatterbot/admin.py",
96+
"chatterbot/ext/django_chatterbot/migrations/0014_remove_statement_extra_data.py",
97+
"chatterbot/ext/django_chatterbot/migrations/__init__.py",
98+
"chatterbot/ext/django_chatterbot/migrations/0005_statement_created_at.py",
99+
"chatterbot/ext/django_chatterbot/migrations/0011_blank_extra_data.py",
100+
"chatterbot/ext/django_chatterbot/migrations/0016_statement_stemmed_text.py",
101+
"chatterbot/ext/django_chatterbot/migrations/0020_alter_statement_conversation_and_more.py",
102+
"chatterbot/ext/django_chatterbot/migrations/0019_alter_statement_id_alter_tag_id_and_more.py",
103+
"chatterbot/ext/django_chatterbot/migrations/0018_text_max_length.py",
104+
"chatterbot/ext/django_chatterbot/migrations/0002_statement_extra_data.py",
105+
"chatterbot/ext/django_chatterbot/migrations/0003_change_occurrence_default.py",
106+
"chatterbot/ext/django_chatterbot/migrations/0001_initial.py",
107+
"chatterbot/ext/django_chatterbot/migrations/0010_statement_text.py",
108+
"chatterbot/ext/django_chatterbot/migrations/0004_rename_in_response_to.py",
109+
"chatterbot/ext/django_chatterbot/migrations/0012_statement_created_at.py",
110+
"chatterbot/ext/django_chatterbot/migrations/0009_tags.py",
111+
"chatterbot/ext/django_chatterbot/migrations/0008_update_conversations.py",
112+
"chatterbot/ext/django_chatterbot/migrations/0015_statement_persona.py",
113+
"chatterbot/ext/django_chatterbot/migrations/0013_change_conversations.py",
114+
"chatterbot/ext/django_chatterbot/migrations/0006_create_conversation.py",
115+
"chatterbot/ext/django_chatterbot/migrations/0007_response_created_at.py",
116+
"chatterbot/ext/django_chatterbot/migrations/0017_tags_unique.py",
117+
"chatterbot/ext/sqlalchemy_app/__init__.py",
118+
"chatterbot/ext/sqlalchemy_app/models.py",
119+
"chatterbot/storage/storage_adapter.py",
80120
"chatterbot/storage/__init__.py",
81121
"chatterbot/storage/mongodb.py",
82122
"chatterbot/storage/redis.py",
83123
"chatterbot/storage/sql_storage.py",
84-
"chatterbot/storage/django_storage.py",
85-
"chatterbot/corpus.py",
86-
"chatterbot/trainers.py",
87-
"chatterbot/storage/storage_adapter.py"
124+
"chatterbot/storage/django_storage.py"
88125
],
89126
"can_expand": true
90127
},
@@ -106,8 +143,10 @@
106143
}
107144
],
108145
"assigned_files": [
146+
"chatterbot/tagging.py",
147+
"chatterbot/parsing.py",
109148
"chatterbot/preprocessors.py",
110-
"chatterbot/parsing.py"
149+
"chatterbot/languages.py"
111150
],
112151
"can_expand": true
113152
},
@@ -132,50 +171,6 @@
132171
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
133172
"referenced_source_code": [],
134173
"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",
179174
"examples/training_example_chatterbot_corpus.py",
180175
"examples/__init__.py",
181176
"examples/basic_example.py",
@@ -206,7 +201,12 @@
206201
"examples/django_example/django_example/management/commands/train.py",
207202
"docs/conf.py",
208203
"docs/_ext/github.py",
209-
"docs/_ext/canonical.py"
204+
"docs/_ext/canonical.py",
205+
"chatterbot/adapters.py",
206+
"chatterbot/constants.py",
207+
"chatterbot/utils.py",
208+
"chatterbot/exceptions.py",
209+
"chatterbot/ext/__init__.py"
210210
],
211211
"can_expand": false
212212
},
@@ -294,6 +294,13 @@
294294
"assigned_files": [],
295295
"can_expand": false
296296
},
297+
{
298+
"name": "Unclassified",
299+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
300+
"referenced_source_code": [],
301+
"assigned_files": [],
302+
"can_expand": false
303+
},
297304
{
298305
"name": "Unclassified",
299306
"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": "88813a8cb799b34bf686041a5d3a91ba95f861cd",
2+
"commit_hash": "d18ea58e6863baa710652cf09ee258784c9dfa09",
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
@@ -23,6 +23,7 @@ Overview
2323
Unclassified["Unclassified"]
2424
Unclassified["Unclassified"]
2525
Unclassified["Unclassified"]
26+
Unclassified["Unclassified"]
2627
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
2728
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
2829
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -208,3 +209,10 @@ Unclassified
208209
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
209210

210211
**Related Classes/Methods**: *None*
212+
213+
Unclassified
214+
^^^^^^^^^^^^
215+
216+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
217+
218+
**Related Classes/Methods**: *None*

docs/architecture/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Overview
2323
Unclassified["Unclassified"]
2424
Unclassified["Unclassified"]
2525
Unclassified["Unclassified"]
26+
Unclassified["Unclassified"]
2627
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
2728
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
2829
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -208,3 +209,10 @@ Unclassified
208209
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
209210

210211
**Related Classes/Methods**: *None*
212+
213+
Unclassified
214+
^^^^^^^^^^^^
215+
216+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
217+
218+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)