Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gsheni authored Aug 28, 2023
1 parent ad87380 commit 1b3a7be
Showing 1 changed file with 33 additions and 23 deletions.
56 changes: 33 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,63 @@

<p align="center">
<img width=30% src="https://github.com/trane-dev/Trane/blob/main/docs/image.jpeg" alt=“Trane_Logo” />
<img width=30% src="https://github.com/trane-dev/Trane/blob/main/docs/image.jpeg" alt="Trane Logo" />
</p>

<p align="center">
<a href="https://github.com/trane-dev/Trane/actions/workflows/tests.yaml" target="_blank">
<img src="https://github.com/trane-dev/Trane/actions/workflows/tests.yaml/badge.svg" alt="Tests" />
<a href="https://github.com/trane-dev/Trane/actions/workflows/tests.yaml">
<img src="https://github.com/trane-dev/Trane/actions/workflows/tests.yaml/badge.svg" alt="Tests Status" />
</a>
<a href="https://codecov.io/gh/trane-dev/Trane" >
<img src="https://codecov.io/gh/trane-dev/Trane/branch/main/graph/badge.svg?token=HafAlYGH8F"/>
<a href="https://codecov.io/gh/trane-dev/Trane">
<img src="https://codecov.io/gh/trane-dev/Trane/branch/main/graph/badge.svg?token=HafAlYGH8F" alt="Code Coverage" />
</a>
<a href="https://badge.fury.io/py/Trane" target="_blank">
<a href="https://badge.fury.io/py/Trane">
<img src="https://badge.fury.io/py/Trane.svg?maxAge=2592000" alt="PyPI Version" />
</a>
<a href="https://pepy.tech/project/Trane" target="_blank">
<img src="https://static.pepy.tech/badge/tran" alt="PyPI Downloads" />
<a href="https://pepy.tech/project/Trane">
<img src="https://static.pepy.tech/badge/trane" alt="PyPI Downloads" />
</a>
</p>

<hr>

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.
**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.

# Install
## Install

To install Trane, run the following command:
Install Trane using pip:

```shell
python -m pip install trane
```

# Example
## Usage

Here's a quick demonstration of Trane in action:

Below is an example of using Trane:
```python
import trane

data, metadata = trane.load_airbnb()
entity_columns = ["location"]
window_size = "2d"

problem_generator = trane.ProblemGenerator(
metadata=metadata,
window_size=window_size,
entity_columns=entity_columns
)
problems = problem_generator.generate()
print(f'Generated {len(problems)} problems')

print(f'Generated {len(problems)} problems.')
print(problems[108])
print(problems[108].create_target_values(data).head(5))
```

```text
Generated 168 problems
For each <location> predict the majority <rating> in all related records in next 2d days
Output:

```
Generated 168 problems.
For each <location> predict the majority <rating> in all related records in the next 2 days.
location time target
0 London 2021-01-01 5
1 London 2021-01-03 4
Expand All @@ -58,14 +66,16 @@ For each <location> predict the majority <rating> in all related records in next
4 London 2021-01-09 5
```

# Community
- Need help? Use a [GitHub issue](https://github.com/trane-dev/Trane/issues)
- Prefer chatting? [Join Slack](https://join.slack.com/t/trane-dev/shared_invite/zt-1zglnh25c-ryuQFarw0rVgKHC6ywUOlg)
## Community

- **Questions or Issues?** Create a [GitHub issue](https://github.com/trane-dev/Trane/issues).
- **Want to Chat?** [Join our Slack community](https://join.slack.com/t/trane-dev/shared_invite/zt-1zglnh25c-ryuQFarw0rVgKHC6ywUOlg).

## Cite Trane

# Citing Trane
If you use Trane, please consider citing the following paper:
If you find Trane beneficial, consider citing our paper:

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
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.

BibTeX entry:

Expand Down

0 comments on commit 1b3a7be

Please sign in to comment.