Skip to content

Commit 5588144

Browse files
committed
docs: refactor documentation to markdown syntax
1 parent 63fd90e commit 5588144

File tree

1 file changed

+101
-111
lines changed
  • project-bikesharing/Bike-Sharing-Dataset

1 file changed

+101
-111
lines changed

Diff for: project-bikesharing/Bike-Sharing-Dataset/README.md

+101-111
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,101 @@
1-
==========================================
2-
Bike Sharing Dataset
3-
==========================================
4-
5-
Hadi Fanaee-T
6-
7-
Laboratory of Artificial Intelligence and Decision Support (LIAAD), University of Porto
8-
INESC Porto, Campus da FEUP
9-
Rua Dr. Roberto Frias, 378
10-
4200 - 465 Porto, Portugal
11-
12-
13-
=========================================
14-
Background
15-
=========================================
16-
17-
Bike sharing systems are new generation of traditional bike rentals where whole process from membership, rental and return
18-
back has become automatic. Through these systems, user is able to easily rent a bike from a particular position and return
19-
back at another position. Currently, there are about over 500 bike-sharing programs around the world which is composed of
20-
over 500 thousands bicycles. Today, there exists great interest in these systems due to their important role in traffic,
21-
environmental and health issues.
22-
23-
Apart from interesting real world applications of bike sharing systems, the characteristics of data being generated by
24-
these systems make them attractive for the research. Opposed to other transport services such as bus or subway, the duration
25-
of travel, departure and arrival position is explicitly recorded in these systems. This feature turns bike sharing system into
26-
a virtual sensor network that can be used for sensing mobility in the city. Hence, it is expected that most of important
27-
events in the city could be detected via monitoring these data.
28-
29-
=========================================
30-
Data Set
31-
=========================================
32-
Bike-sharing rental process is highly correlated to the environmental and seasonal settings. For instance, weather conditions,
33-
precipitation, day of week, season, hour of the day, etc. can affect the rental behaviors. The core data set is related to
34-
the two-year historical log corresponding to years 2011 and 2012 from Capital Bikeshare system, Washington D.C., USA which is
35-
publicly available in http://capitalbikeshare.com/system-data. We aggregated the data on two hourly and daily basis and then
36-
extracted and added the corresponding weather and seasonal information. Weather information are extracted from http://www.freemeteo.com.
37-
38-
=========================================
39-
Associated tasks
40-
=========================================
41-
42-
- Regression:
43-
Prediction of bike rental count hourly or daily based on the environmental and seasonal settings.
44-
45-
- Event and Anomaly Detection:
46-
Count of rented bikes are also correlated to some events in the town which easily are traceable via search engines.
47-
For instance, query like "2012-10-30 washington d.c." in Google returns related results to Hurricane Sandy. Some of the important events are
48-
identified in [1]. Therefore the data can be used for validation of anomaly or event detection algorithms as well.
49-
50-
51-
=========================================
52-
Files
53-
=========================================
54-
55-
- Readme.txt
56-
- hour.csv : bike sharing counts aggregated on hourly basis. Records: 17379 hours
57-
- day.csv - bike sharing counts aggregated on daily basis. Records: 731 days
58-
59-
60-
=========================================
61-
Dataset characteristics
62-
=========================================
63-
Both hour.csv and day.csv have the following fields, except hr which is not available in day.csv
64-
65-
- instant: record index
66-
- dteday : date
67-
- season : season (1:springer, 2:summer, 3:fall, 4:winter)
68-
- yr : year (0: 2011, 1:2012)
69-
- mnth : month ( 1 to 12)
70-
- hr : hour (0 to 23)
71-
- holiday : weather day is holiday or not (extracted from http://dchr.dc.gov/page/holiday-schedule)
72-
- weekday : day of the week
73-
- workingday : if day is neither weekend nor holiday is 1, otherwise is 0.
74-
+ weathersit :
75-
- 1: Clear, Few clouds, Partly cloudy, Partly cloudy
76-
- 2: Mist + Cloudy, Mist + Broken clouds, Mist + Few clouds, Mist
77-
- 3: Light Snow, Light Rain + Thunderstorm + Scattered clouds, Light Rain + Scattered clouds
78-
- 4: Heavy Rain + Ice Pallets + Thunderstorm + Mist, Snow + Fog
79-
- temp : Normalized temperature in Celsius. The values are divided to 41 (max)
80-
- atemp: Normalized feeling temperature in Celsius. The values are divided to 50 (max)
81-
- hum: Normalized humidity. The values are divided to 100 (max)
82-
- windspeed: Normalized wind speed. The values are divided to 67 (max)
83-
- casual: count of casual users
84-
- registered: count of registered users
85-
- cnt: count of total rental bikes including both casual and registered
86-
87-
=========================================
88-
License
89-
=========================================
90-
Use of this dataset in publications must be cited to the following publication:
91-
92-
[1] Fanaee-T, Hadi, and Gama, Joao, "Event labeling combining ensemble detectors and background knowledge", Progress in Artificial Intelligence (2013): pp. 1-15, Springer Berlin Heidelberg, doi:10.1007/s13748-013-0040-3.
93-
94-
@article{
95-
year={2013},
96-
issn={2192-6352},
97-
journal={Progress in Artificial Intelligence},
98-
doi={10.1007/s13748-013-0040-3},
99-
title={Event labeling combining ensemble detectors and background knowledge},
100-
url={http://dx.doi.org/10.1007/s13748-013-0040-3},
101-
publisher={Springer Berlin Heidelberg},
102-
keywords={Event labeling; Event detection; Ensemble learning; Background knowledge},
103-
author={Fanaee-T, Hadi and Gama, Joao},
104-
pages={1-15}
105-
}
106-
107-
=========================================
108-
Contact
109-
=========================================
110-
111-
For further information about this dataset please contact Hadi Fanaee-T ([email protected])
1+
# Bike Sharing Dataset
2+
3+
## Author
4+
5+
[Hadi Fanaee-T](mailto:[email protected])
6+
7+
[Laboratory of Artificial Intelligence and Decision Support (LIAAD)][liad-homepage-url]
8+
9+
[INESC Porto, Campus da FEUP][feup-address-url] at [University of Porto][uporto-url]
10+
11+
12+
## Background
13+
14+
Bike sharing systems are new generation of traditional bike rentals where whole process from membership, rental and return back has become automatic. Through these systems, user is able to easily rent a bike from a particular position and return back at another position.
15+
16+
Currently, there are about over 500 bike-sharing programs around the world which is composed of over 500 thousands bicycles. Today, there exists great interest in these systems due to their important role in traffic, environmental and health issues. Apart from interesting real world applications of bike sharing systems, the characteristics of data being generated by these systems make them attractive for the research.
17+
18+
Opposed to other transport services such as bus or subway, the duration of travel, departure and arrival position is explicitly recorded in these systems. This feature turns bike sharing system into a virtual sensor network that can be used for sensing mobility in the city.
19+
20+
Hence, it is expected that most of important events in the city could be detected via monitoring these data.
21+
22+
## Data Set
23+
24+
Bike-sharing rental process is highly correlated to the environmental and seasonal settings. For instance, weather conditions, precipitation, day of week, season, hour of the day, etc. can affect the rental behaviors.
25+
26+
The core data set is related to the two-year historical log corresponding to years 2011 and 2012 from Capital Bikeshare system, Washington D.C., USA which is publicly available in the [Capital Bikeshare system data][capitalbikeshare-url].
27+
28+
We aggregated the data on two hourly and daily basis and then extracted and added the corresponding weather and seasonal information. Weather information are extracted from [Free Metereology][freemeteo-url].
29+
30+
## Associated tasks
31+
32+
- **Regression**:
33+
34+
- Prediction of bike rental count hourly or daily based on the environmental and seasonal settings.
35+
36+
- **Event and Anomaly Detection**:
37+
38+
- Count of rented bikes are also correlated to some events in the town which easily are traceable via search engines.
39+
- For instance, query like "2012-10-30 washington d.c." in Google returns related results to Hurricane Sandy.
40+
- Some of the important events are identified. <sup>[1](#License)</sup>.
41+
- Therefore the data can be used for validation of anomaly or event detection algorithms as well.
42+
43+
## Files
44+
45+
- [`README.md`](./README.md)
46+
- [`hour.csv`](./hour.csv): bike sharing counts aggregated on hourly basis. Records: 17379 hours
47+
- [`day.csv`](day.csv): bike sharing counts aggregated on daily basis. Records: 731 days
48+
49+
## Dataset characteristics
50+
51+
Both [`hour.csv`](./hour.csv) and [`day.csv`](day.csv) have the following fields, except hr which is not available in [`day.csv`](day.csv).
52+
53+
- `instant`: record index
54+
- `dteday`: date
55+
- `season`: season (1:springer, 2:summer, 3:fall, 4:winter)
56+
- `yr`: year (0: 2011, 1:2012)
57+
- `mnth`: month (1 to 12)
58+
- `hr`: hour (0 to 23)
59+
- `holiday`: weather [day is holiday or not][holiday-schedule-url]
60+
- `weekday`: day of the week
61+
- `workingday`: if day is neither weekend nor holiday is 1, otherwise is 0.
62+
- `weathersit`:
63+
1. Clear, Few clouds, Partly cloudy, Partly cloudy
64+
2. Mist + Cloudy, Mist + Broken clouds, Mist + Few clouds, Mist
65+
3. Light Snow, Light Rain + Thunderstorm + Scattered clouds, Light Rain + Scattered clouds
66+
4. Heavy Rain + Ice Pallets + Thunderstorm + Mist, Snow + Fog
67+
- `temp`: Normalized temperature in Celsius. The values are divided to 41 (max)
68+
- `atemp`: Normalized feeling temperature in Celsius. The values are divided to 50 (max)
69+
- `hum`: Normalized humidity. The values are divided to 100 (max)
70+
- `windspeed`: Normalized wind speed. The values are divided to 67 (max)
71+
- `casual`: count of casual users
72+
- `registered`: count of registered users
73+
- `cnt`: count of total rental bikes including both casual and registered
74+
75+
## [License](#1)
76+
77+
Use of this dataset in publications must be cited to the following publication:
78+
79+
[1] Fanaee-T, Hadi, and Gama, Joao, "Event labeling combining ensemble detectors and background knowledge", _Progress in Artificial Intelligence_ (2013): pp. 1-15, Springer Berlin Heidelberg, doi:10.1007/s13748-013-0040-3.
80+
81+
82+
@article{
83+
year={2013},
84+
issn={2192-6352},
85+
journal={Progress in Artificial Intelligence},
86+
doi={10.1007/s13748-013-0040-3},
87+
title={Event labeling combining ensemble detectors and background knowledge},
88+
url={http://dx.doi.org/10.1007/s13748-013-0040-3},
89+
publisher={Springer Berlin Heidelberg},
90+
keywords={Event labeling; Event detection; Ensemble learning; Background knowledge},
91+
author={Fanaee-T, Hadi and Gama, Joao},
92+
pages={1-15}
93+
}
94+
95+
96+
[capitalbikeshare-url]: http://capitalbikeshare.com/system-data
97+
[feup-address-url]: https://goo.gl/maps/HykYYt8ifSCPPsQb8
98+
[freemeteo-url]: http://www.freemeteo.com
99+
[holiday-schedule-url]: http://dchr.dc.gov/page/holiday-schedule
100+
[liad-homepage-url]: https://www.liad.pt
101+
[uporto-url]: https://www.up.pt

0 commit comments

Comments
 (0)