Skip to content

Commit 8d77b37

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: 4 - JSON files created/updated: 5 - 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 95fe9ea commit 8d77b37

6 files changed

Lines changed: 52 additions & 96 deletions

File tree

‎.codeboarding/Chatbot_Core_Engine.json‎

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@
1717
"reference_start_line": null,
1818
"reference_end_line": null
1919
}
20-
],
21-
"assigned_files": [],
22-
"can_expand": false
20+
]
2321
},
2422
{
2523
"name": "Text Splitter",
@@ -31,9 +29,7 @@
3129
"reference_start_line": null,
3230
"reference_end_line": null
3331
}
34-
],
35-
"assigned_files": [],
36-
"can_expand": true
32+
]
3733
},
3834
{
3935
"name": "Vector Store",
@@ -45,9 +41,7 @@
4541
"reference_start_line": null,
4642
"reference_end_line": null
4743
}
48-
],
49-
"assigned_files": [],
50-
"can_expand": true
44+
]
5145
},
5246
{
5347
"name": "Embeddings Model",
@@ -59,9 +53,7 @@
5953
"reference_start_line": null,
6054
"reference_end_line": null
6155
}
62-
],
63-
"assigned_files": [],
64-
"can_expand": false
56+
]
6557
},
6658
{
6759
"name": "Language Model (LLM)",
@@ -73,9 +65,7 @@
7365
"reference_start_line": null,
7466
"reference_end_line": null
7567
}
76-
],
77-
"assigned_files": [],
78-
"can_expand": true
68+
]
7969
},
8070
{
8171
"name": "Retrieval Chain",
@@ -87,19 +77,12 @@
8777
"reference_start_line": null,
8878
"reference_end_line": null
8979
}
90-
],
91-
"assigned_files": [],
92-
"can_expand": false
80+
]
9381
},
9482
{
9583
"name": "Unclassified",
9684
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
97-
"referenced_source_code": [],
98-
"assigned_files": [
99-
"chatterbot/conversation.py",
100-
"chatterbot/chatterbot.py"
101-
],
102-
"can_expand": false
85+
"referenced_source_code": []
10386
}
10487
],
10588
"components_relations": [

‎.codeboarding/Data_Storage_Training.json‎

Lines changed: 4 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -11,41 +11,7 @@
1111
"reference_start_line": null,
1212
"reference_end_line": null
1313
}
14-
],
15-
"assigned_files": [
16-
"chatterbot/storage/storage_adapter.py",
17-
"chatterbot/storage/mongodb.py",
18-
"chatterbot/storage/redis.py",
19-
"chatterbot/storage/sql_storage.py",
20-
"chatterbot/storage/django_storage.py",
21-
"chatterbot/ext/django_chatterbot/models.py",
22-
"chatterbot/ext/django_chatterbot/abstract_models.py",
23-
"chatterbot/ext/django_chatterbot/migrations/0014_remove_statement_extra_data.py",
24-
"chatterbot/ext/django_chatterbot/migrations/__init__.py",
25-
"chatterbot/ext/django_chatterbot/migrations/0005_statement_created_at.py",
26-
"chatterbot/ext/django_chatterbot/migrations/0011_blank_extra_data.py",
27-
"chatterbot/ext/django_chatterbot/migrations/0016_statement_stemmed_text.py",
28-
"chatterbot/ext/django_chatterbot/migrations/0020_alter_statement_conversation_and_more.py",
29-
"chatterbot/ext/django_chatterbot/migrations/0019_alter_statement_id_alter_tag_id_and_more.py",
30-
"chatterbot/ext/django_chatterbot/migrations/0018_text_max_length.py",
31-
"chatterbot/ext/django_chatterbot/migrations/0002_statement_extra_data.py",
32-
"chatterbot/ext/django_chatterbot/migrations/0003_change_occurrence_default.py",
33-
"chatterbot/ext/django_chatterbot/migrations/0001_initial.py",
34-
"chatterbot/ext/django_chatterbot/migrations/0010_statement_text.py",
35-
"chatterbot/ext/django_chatterbot/migrations/0004_rename_in_response_to.py",
36-
"chatterbot/ext/django_chatterbot/migrations/0012_statement_created_at.py",
37-
"chatterbot/ext/django_chatterbot/migrations/0009_tags.py",
38-
"chatterbot/ext/django_chatterbot/migrations/0008_update_conversations.py",
39-
"chatterbot/ext/django_chatterbot/migrations/0015_statement_persona.py",
40-
"chatterbot/ext/django_chatterbot/migrations/0013_change_conversations.py",
41-
"chatterbot/ext/django_chatterbot/migrations/0006_create_conversation.py",
42-
"chatterbot/ext/django_chatterbot/migrations/0007_response_created_at.py",
43-
"chatterbot/ext/django_chatterbot/migrations/0017_tags_unique.py",
44-
"chatterbot/ext/sqlalchemy_app/__init__.py",
45-
"chatterbot/ext/sqlalchemy_app/models.py",
46-
"chatterbot/vectorstores.py"
47-
],
48-
"can_expand": true
14+
]
4915
},
5016
{
5117
"name": "Training Module",
@@ -57,11 +23,7 @@
5723
"reference_start_line": 14,
5824
"reference_end_line": 77
5925
}
60-
],
61-
"assigned_files": [
62-
"chatterbot/trainers.py"
63-
],
64-
"can_expand": true
26+
]
6527
},
6628
{
6729
"name": "Corpus Data Loader",
@@ -73,24 +35,12 @@
7335
"reference_start_line": 1,
7436
"reference_end_line": 10
7537
}
76-
],
77-
"assigned_files": [
78-
"chatterbot/corpus.py"
79-
],
80-
"can_expand": true
38+
]
8139
},
8240
{
8341
"name": "Unclassified",
8442
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
85-
"referenced_source_code": [],
86-
"assigned_files": [
87-
"chatterbot/ext/django_chatterbot/__init__.py",
88-
"chatterbot/ext/django_chatterbot/apps.py",
89-
"chatterbot/ext/django_chatterbot/settings.py",
90-
"chatterbot/ext/django_chatterbot/model_admin.py",
91-
"chatterbot/ext/django_chatterbot/admin.py"
92-
],
93-
"can_expand": false
43+
"referenced_source_code": []
9444
}
9545
],
9646
"components_relations": [

‎.codeboarding/analysis.json‎

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
],
1515
"assigned_files": [
1616
"chatterbot/conversation.py",
17+
"chatterbot/components.py",
1718
"chatterbot/chatterbot.py"
1819
],
1920
"can_expand": true
@@ -42,17 +43,15 @@
4243
}
4344
],
4445
"assigned_files": [
46+
"chatterbot/search.py",
4547
"chatterbot/response_selection.py",
4648
"chatterbot/comparisons.py",
4749
"chatterbot/logic/unit_conversion.py",
4850
"chatterbot/logic/mathematical_evaluation.py",
4951
"chatterbot/logic/logic_adapter.py",
5052
"chatterbot/logic/best_match.py",
5153
"chatterbot/logic/specific_response.py",
52-
"chatterbot/logic/time_adapter.py",
53-
"chatterbot/search.py",
54-
"chatterbot/tagging.py",
55-
"chatterbot/filters.py"
54+
"chatterbot/logic/time_adapter.py"
5655
],
5756
"can_expand": true
5857
},
@@ -81,16 +80,11 @@
8180
],
8281
"assigned_files": [
8382
"chatterbot/corpus.py",
83+
"chatterbot/vectorstores.py",
8484
"chatterbot/trainers.py",
85-
"chatterbot/ext/django_chatterbot/__init__.py",
86-
"chatterbot/ext/django_chatterbot/apps.py",
8785
"chatterbot/ext/django_chatterbot/models.py",
8886
"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",
9287
"chatterbot/ext/django_chatterbot/migrations/0014_remove_statement_extra_data.py",
93-
"chatterbot/ext/django_chatterbot/migrations/__init__.py",
9488
"chatterbot/ext/django_chatterbot/migrations/0005_statement_created_at.py",
9589
"chatterbot/ext/django_chatterbot/migrations/0011_blank_extra_data.py",
9690
"chatterbot/ext/django_chatterbot/migrations/0016_statement_stemmed_text.py",
@@ -110,14 +104,12 @@
110104
"chatterbot/ext/django_chatterbot/migrations/0006_create_conversation.py",
111105
"chatterbot/ext/django_chatterbot/migrations/0007_response_created_at.py",
112106
"chatterbot/ext/django_chatterbot/migrations/0017_tags_unique.py",
113-
"chatterbot/ext/sqlalchemy_app/__init__.py",
114107
"chatterbot/ext/sqlalchemy_app/models.py",
115108
"chatterbot/storage/storage_adapter.py",
116109
"chatterbot/storage/mongodb.py",
117110
"chatterbot/storage/redis.py",
118111
"chatterbot/storage/sql_storage.py",
119-
"chatterbot/storage/django_storage.py",
120-
"chatterbot/vectorstores.py"
112+
"chatterbot/storage/django_storage.py"
121113
],
122114
"can_expand": true
123115
},
@@ -139,8 +131,11 @@
139131
}
140132
],
141133
"assigned_files": [
134+
"chatterbot/tagging.py",
142135
"chatterbot/parsing.py",
143-
"chatterbot/preprocessors.py"
136+
"chatterbot/preprocessors.py",
137+
"chatterbot/filters.py",
138+
"chatterbot/languages.py"
144139
],
145140
"can_expand": true
146141
},
@@ -158,7 +153,7 @@
158153
"assigned_files": [
159154
"chatterbot/llm.py"
160155
],
161-
"can_expand": true
156+
"can_expand": false
162157
},
163158
{
164159
"name": "Unclassified",
@@ -201,15 +196,27 @@
201196
"chatterbot/__main__.py",
202197
"chatterbot/constants.py",
203198
"chatterbot/utils.py",
204-
"chatterbot/components.py",
205199
"chatterbot/exceptions.py",
206-
"chatterbot/languages.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
],
211211
"can_expand": false
212212
},
213+
{
214+
"name": "Unclassified",
215+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
216+
"referenced_source_code": [],
217+
"assigned_files": [],
218+
"can_expand": false
219+
},
213220
{
214221
"name": "Unclassified",
215222
"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": "1a69a48cd8505d4948ce7c7f51c34963878b4dae",
2+
"commit_hash": "95fe9eac1cab27669e200424ddf3a063cf91ed3d",
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
@@ -11,6 +11,7 @@ Overview
1111
LLM_Integration["LLM Integration"]
1212
Unclassified["Unclassified"]
1313
Unclassified["Unclassified"]
14+
Unclassified["Unclassified"]
1415
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
1516
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
1617
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -106,3 +107,10 @@ Unclassified
106107
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
107108

108109
**Related Classes/Methods**: *None*
110+
111+
Unclassified
112+
^^^^^^^^^^^^
113+
114+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
115+
116+
**Related Classes/Methods**: *None*

‎docs/architecture/overview.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Overview
1111
LLM_Integration["LLM Integration"]
1212
Unclassified["Unclassified"]
1313
Unclassified["Unclassified"]
14+
Unclassified["Unclassified"]
1415
Chatbot_Core_Engine -- "Receives Processed Input From" --> Input_Output_Processors
1516
Chatbot_Core_Engine -- "Delegates Response Generation To" --> Logic_Response_Adapters
1617
Logic_Response_Adapters -- "Queries Knowledge Base From" --> Data_Storage_Training
@@ -106,3 +107,10 @@ Unclassified
106107
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
107108

108109
**Related Classes/Methods**: *None*
110+
111+
Unclassified
112+
^^^^^^^^^^^^
113+
114+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
115+
116+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)