Skip to content

Commit 58ab666

Browse files
committed
fixing use documentation.
1 parent b70244e commit 58ab666

File tree

1 file changed

+1
-24
lines changed

1 file changed

+1
-24
lines changed

README.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -51,30 +51,7 @@ pip install kmds
5151

5252
### 2. Usage
5353

54-
As you work through your analysis, log your findings to `kmds`. Here's a basic workflow:
55-
56-
1. **Import KMDS:**
57-
```python
58-
from kmds import KnowledgeManagement
59-
```
60-
61-
2. **Initialize the Knowledge Base:**
62-
```python
63-
km = KnowledgeManagement()
64-
```
65-
66-
3. **Log Your Findings:**
67-
```python
68-
km.log_finding("My observation during EDA", "This is what I found...")
69-
```
70-
71-
4. **Export Your Knowledge Base:**
72-
```python
73-
km.export("my_project_knowledge_base.txt")
74-
```
75-
76-
5. **Generate Reports:**
77-
Point a generative AI tool to your exported knowledge base to create reports, presentations, and other documentation.
54+
As you work through your analysis, log your findings to `kmds`. Check out the examples below.
7855

7956
---
8057

0 commit comments

Comments
 (0)