You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Refactor dev dependencies and update installation steps
Renamed `requirements.txt` to `requirements-dev.txt` and moved development dependencies to an `extras_require` block in `setup.py`. Updated the README with instructions for installing development dependencies and clarified their purpose. This refactoring improves dependency management and developer onboarding.
For contributors and developers, GSP-Py provides additional dependencies for development purposes (e.g., testing and linting).
83
+
84
+
To install the package along with development dependencies, use:
85
+
```bash
86
+
pip install .[dev]
87
+
```
88
+
89
+
The `dev` category includes tools such as `pytest`, `pylint`, and others to ensure code quality and maintainability.
90
+
79
91
## 💡 Usage
80
92
81
93
The library is designed to be easy to use and integrate with your own projects. Below is an example of how you can configure and run GSP-Py.
@@ -97,6 +109,15 @@ Import the `GSP` class from the `gsppy` package and call the `search` method to
97
109
```python
98
110
from gsppy.gsp importGSP
99
111
112
+
# Define the input data
113
+
transactions = [
114
+
['Bread', 'Milk'],
115
+
['Bread', 'Diaper', 'Beer', 'Eggs'],
116
+
['Milk', 'Diaper', 'Beer', 'Coke'],
117
+
['Bread', 'Milk', 'Diaper', 'Beer'],
118
+
['Bread', 'Milk', 'Diaper', 'Coke']
119
+
]
120
+
100
121
# Minimum support set to 30%
101
122
min_support =0.3
102
123
@@ -127,6 +148,10 @@ We are actively working to improve GSP-Py. Here are some exciting features plann
127
148
2.**Support for Preprocessing and Postprocessing**:
128
149
- Add hooks to allow users to transform datasets before mining and customize the output results.
129
150
151
+
3.**Support for Time-Constrained Pattern Mining**:
152
+
- Extend GSP-Py to handle temporal datasets by allowing users to define time constraints (e.g., maximum time gaps between events, time windows) during the sequence mining process.
153
+
- Enable candidate pruning and support calculations based on these temporal constraints.
154
+
130
155
Want to contribute or suggest an improvement? [Open a discussion or issue!](https://github.com/jacksonpradolima/gsp-py/issues)
131
156
132
157
---
@@ -135,6 +160,11 @@ Want to contribute or suggest an improvement? [Open a discussion or issue!](http
135
160
136
161
We welcome contributions from the community! If you'd like to help improve GSP-Py, read our [CONTRIBUTING.md](CONTRIBUTING.md) guide to get started.
137
162
163
+
Development dependencies (e.g., testing and linting tools) are included in the `dev` category in `setup.py`. To install these dependencies, run:
164
+
```bash
165
+
pip install .[dev]
166
+
```
167
+
138
168
### General Steps:
139
169
1. Fork the repository.
140
170
2. Create a feature branch: `git checkout -b feature/my-feature`.
0 commit comments