Skip to content

Commit b9e01d1

Browse files
authored
Update README.md (#152)
* Update README.md * Update README.md
1 parent ad87380 commit b9e01d1

File tree

1 file changed

+30
-20
lines changed

1 file changed

+30
-20
lines changed

README.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,63 @@
1+
12
<p align="center">
2-
<img width=30% src="https://github.com/trane-dev/Trane/blob/main/docs/image.jpeg" alt=“Trane_Logo” />
3+
<img width=30% src="https://github.com/trane-dev/Trane/blob/main/docs/image.jpeg" alt="Trane Logo" />
34
</p>
45

56
<p align="center">
67
<a href="https://github.com/trane-dev/Trane/actions/workflows/tests.yaml" target="_blank">
7-
<img src="https://github.com/trane-dev/Trane/actions/workflows/tests.yaml/badge.svg" alt="Tests" />
8+
<img src="https://github.com/trane-dev/Trane/actions/workflows/tests.yaml/badge.svg" alt="Tests Status" />
89
</a>
9-
<a href="https://codecov.io/gh/trane-dev/Trane" >
10-
<img src="https://codecov.io/gh/trane-dev/Trane/branch/main/graph/badge.svg?token=HafAlYGH8F"/>
10+
<a href="https://codecov.io/gh/trane-dev/Trane" target="_blank">
11+
<img src="https://codecov.io/gh/trane-dev/Trane/branch/main/graph/badge.svg?token=HafAlYGH8F" alt="Code Coverage" />
1112
</a>
1213
<a href="https://badge.fury.io/py/Trane" target="_blank">
1314
<img src="https://badge.fury.io/py/Trane.svg?maxAge=2592000" alt="PyPI Version" />
1415
</a>
1516
<a href="https://pepy.tech/project/Trane" target="_blank">
16-
<img src="https://static.pepy.tech/badge/tran" alt="PyPI Downloads" />
17+
<img src="https://static.pepy.tech/badge/trane" alt="PyPI Downloads" />
1718
</a>
1819
</p>
20+
1921
<hr>
2022

21-
Trane is a software package designed to automatically generate problems for temporal datasets and produce labels for supervised learning. It aims to enhance the automation of the machine learning problem-solving process.
23+
**Trane** is a software package that automatically generates problems for temporal datasets and produces labels for supervised learning. Its goal is to streamline the machine learning problem-solving process.
2224

23-
# Install
25+
## Install
2426

25-
To install Trane, run the following command:
27+
Install Trane using pip:
2628

2729
```shell
2830
python -m pip install trane
2931
```
3032

31-
# Example
33+
## Usage
34+
35+
Here's a quick demonstration of Trane in action:
3236

33-
Below is an example of using Trane:
3437
```python
3538
import trane
39+
3640
data, metadata = trane.load_airbnb()
3741
entity_columns = ["location"]
3842
window_size = "2d"
43+
3944
problem_generator = trane.ProblemGenerator(
4045
metadata=metadata,
4146
window_size=window_size,
4247
entity_columns=entity_columns
4348
)
4449
problems = problem_generator.generate()
45-
print(f'Generated {len(problems)} problems')
50+
51+
print(f'Generated {len(problems)} problems.')
4652
print(problems[108])
4753
print(problems[108].create_target_values(data).head(5))
4854
```
4955

50-
```text
51-
Generated 168 problems
52-
For each <location> predict the majority <rating> in all related records in next 2d days
56+
Output:
57+
58+
```
59+
Generated 168 problems.
60+
For each <location> predict the majority <rating> in all related records in the next 2 days.
5361
location time target
5462
0 London 2021-01-01 5
5563
1 London 2021-01-03 4
@@ -58,14 +66,16 @@ For each <location> predict the majority <rating> in all related records in next
5866
4 London 2021-01-09 5
5967
```
6068

61-
# Community
62-
- Need help? Use a [GitHub issue](https://github.com/trane-dev/Trane/issues)
63-
- Prefer chatting? [Join Slack](https://join.slack.com/t/trane-dev/shared_invite/zt-1zglnh25c-ryuQFarw0rVgKHC6ywUOlg)
69+
## Community
70+
71+
- **Questions or Issues?** Create a [GitHub issue](https://github.com/trane-dev/Trane/issues).
72+
- **Want to Chat?** [Join our Slack community](https://join.slack.com/t/trane-dev/shared_invite/zt-1zglnh25c-ryuQFarw0rVgKHC6ywUOlg).
73+
74+
## Cite Trane
6475

65-
# Citing Trane
66-
If you use Trane, please consider citing the following paper:
76+
If you find Trane beneficial, consider citing our paper:
6777

68-
Ben Schreck, Kalyan Veeramachaneni. [What Would a Data Scientist Ask? Automatically Formulating and Solving Predictive Problems.](https://dai.lids.mit.edu/wp-content/uploads/2017/10/Trane1.pdf) *IEEE DSAA 2016*, 440-451
78+
Ben Schreck, Kalyan Veeramachaneni. [What Would a Data Scientist Ask? Automatically Formulating and Solving Predictive Problems.](https://dai.lids.mit.edu/wp-content/uploads/2017/10/Trane1.pdf) *IEEE DSAA 2016*, 440-451.
6979

7080
BibTeX entry:
7181

0 commit comments

Comments
 (0)