Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated README #13

Merged
merged 1 commit into from
Jul 27, 2024
Merged

Updated README #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 24 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,30 @@ Implementation of the algorithm [Density-Based Clustering over an Evolving Data
## Installation

```Shell
pip install git+https://github.com/MrParosk/pyDenStream.git
pip install denstream
```

## Example
## Example usage

An example of how to use this package is included in *examples/user_guide.ipynb*.
```python
import numpy as np
from denstream import DenStream

# Model parameters
eps = 0.3
lambd = 0.1
beta = 0.2
mu = 10
min_samples = 1

model = DenStream(eps, beta, mu, lambd, min_samples)

x = np.array([[1, 2]])
t = 0

model.partial_fit(x, t)
```

## In depth example

A more in depth example of how to use this package is included in *examples/user_guide.ipynb*.
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ requires = ["setuptools>=61.0", "wheel>=0.37.1"]

[project]
name = "denstream"
version = "0.1"
version = "0.1.1"
description = "Implementation of the DenStream algorithm"
readme = "README.md"
requires-python = ">=3.8, <3.13"
Expand Down