Skip to content

Commit 608fa18

Browse files
committed
Adding Documentation
1 parent 5677366 commit 608fa18

7 files changed

+239
-167
lines changed

.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
tsBNgen.egg-info
2+
dist
3+
build
4+
.ipynb_checkpoints
5+
.git

README.md

+7-26
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,10 @@
1-
## 0.1. **tsBNgen: A Python Library to Generate Time Series Data Based on an Arbitrary Bayesian Network Structure**
2-
3-
[Description](#Description)
4-
5-
[Citation](Citaton)
6-
7-
[Features](#Features)
8-
9-
[Instruction](#Instruction)
10-
11-
[License](#License)
12-
13-
[Support](#Support)
14-
15-
----
16-
171
### **Description**
182

19-
### tsBNgen is a Python package to generate time series data based on an arbitrary Bayesian Network Structures.
3+
#### tsBNgen is a Python package to generate time series data based on an arbitrary Bayesian Network Structures.
204
---
215
### **Citation**
226

23-
### If you find this package useful or if you use it in your research or work please consider citing it as follows:
7+
#### For the correct citation please visit https://github.com/manitadayon/tsBNgen
248
----
259
### **Features**
2610

@@ -30,9 +14,9 @@
3014

3115
- It handles arbitrary Bayesian network structure.
3216

33-
- It supports loopback 1 (node at time t-1 can be connected to any node at time t) and loopback 2.
17+
- It supports arbitrary loopback values.
3418

35-
- The code can be modified easily to handle arbitrary long loopbacks.
19+
- The code can be modified easily to handle arbitrary static and temporal structures.
3620
---
3721

3822
### **Instruction**
@@ -47,18 +31,15 @@ pip install tsBNgen
4731

4832
> **Time_Series_Generation_Examples.ipynb**
4933
50-
For more information on how to use the package please visit the followings:
34+
For more information on how to use the package please visit the following:
5135

5236
1. Original paper
53-
2. Documentation in PDF available in this repo.
37+
2. Documentation in PDF available in the github repository.
5438

5539
### **License**
5640

57-
This is repo is under the MIT liecense.
58-
59-
### **Support**
41+
This software is released under the MIT liecense.
6042

61-
If you have any question or comment, either open a new issue for this repo or please email me at [email protected].
6243

6344

6445

0 commit comments

Comments
 (0)