-
Notifications
You must be signed in to change notification settings - Fork 7
/
usingFlow.html
executable file
·160 lines (148 loc) · 10.9 KB
/
usingFlow.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- -->
<!-- Document Title-->
<!-- =============================================-->
<title>Using Flow</title>
<!-- -->
<!-- Favicons-->
<!-- =============================================-->
<script src="assets/js/favicon.js"></script>
<meta name="theme-color" content="#ffffff">
<!-- -->
<!-- Stylesheets-->
<!-- =============================================-->
<!-- Default stylesheets-->
<link href="assets/lib/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet">
<!-- Template specific stylesheets-->
<link href="https://fonts.googleapis.com/css?family=Montserrat:100,300,400,600" rel="stylesheet">
<link href="https://fonts.googleapis.com/css?family=Droid+Serif:400,400i" rel="stylesheet">
<link href="assets/lib/font-awesome/css/font-awesome.min.css" rel="stylesheet">
<link href="assets/lib/iconsmind/iconsmind.css" rel="stylesheet">
<link href="assets/lib/css-hamburgers/dist/hamburgers.css" rel="stylesheet">
<link href="assets/lib/owl.carousel/dist/assets/owl.carousel.min.css" rel="stylesheet">
<link href="assets/lib/owl.carousel/dist/assets/owl.theme.default.min.css" rel="stylesheet">
<link href="assets/lib/semantic-ui-transition/transition.css" rel="stylesheet"/>
<link href="assets/lib/semantic-ui-accordion/accordion.css" rel="stylesheet">
<!-- Main stylesheet and color file-->
<link href="assets/css/style.css" rel="stylesheet">
<link href="assets/css/custom.css" rel="stylesheet"> </head>
<body data-spy="scroll" data-target=".inner-link" data-offset="60">
<main>
<script src="assets/js/header.js"></script>
<section class="text-center background-11 font-1">
<div class="container">
<div class="row justify-content-center">
<div class="col-lg-8">
<h3 class="color-1 mb-4">Using Flow</h3>
<p class="color-4 lead">Flow is available open-source for public use</p>
<a href="https://github.com/flow-project/flow" class="btn btn-icon btn-primary btn-icon-left" target="_blank">
<span class="fa fa-github">
</span> Download from Github
</a>
<hr class="short mb-8 color-8 mt-4">
</div>
</div>
<div class="row">
<div class="col-sm-12">
<p class="color-4 lead">Flow can be installed in 2 ways</p>
</div>
<div class="col-sm-6">
<p class="color-4 lead"> <b>locally</b> on your computer</p>
<a href="https://flow.readthedocs.io/en/latest/flow_setup.html#local-installation" class="btn btn btn-outline-dark" target="_blank">
Local Installation
</a>
</div>
<div class="col-sm-6">
<p class="color-4 lead"><b>virtually</b> from an image.</p>
<a href="https://flow.readthedocs.io/en/latest/flow_setup.html#remote-installation-using-docker" class="btn btn btn-outline-dark" target="_blank">
Virtual Installation
</a>
</div>
<hr class="short mb-8 color-8 mt-4">
</div>
<h4 class="color-1 mb-4" id="faq">FAQ</h4>
<div class="ui styled fluid accordion text-left">
<div class="title">
<i class="dropdown icon"></i> What is Flow?</div>
<div class="content">
<p class="transition hidden">Flow is a deep reinforcement learning framework for mixed autonomy traffic. Flow is a traffic control benchmarking framework and it provides a suite of traffic control scenarios (benchmarks), tools for designing custom traffic scenarios, and integration with deep reinforcement learning and traffic microsimulation libraries.</p>
</div>
<div class="title">
<i class="dropdown icon"></i> Is there any installation instructions?</div>
<div class="content">
<p class="transition hidden">Yes! Please refer to our <a target="_blank" href="https://flow.readthedocs.io/en/latest/flow_setup.html">Installation instructions</a>.</p>
</div>
<div class="title">
<i class="dropdown icon"></i> Does Flow have proper documentation?</div>
<div class="content">
<p class="transition hidden">Yes! In fact Flow has rich documentaion and we frequently update them. Please refer to <a target="_blank" href="https://flow.readthedocs.io/en/latest/">Flow documentation</a>.</p>
</div>
<div class="title active">
<i class="dropdown icon"></i> How can I ask my questions?</div>
<div class="content active">
<p class="transition visible">Please direct technical questions to the project <a target="_blank" href="https://join.slack.com/t/flow-users/shared_invite/enQtODQ0NDYxMTQyNDY2LTY1ZDVjZTljM2U0ODIxNTY5NTQ2MmUxMzYzNzc5NzU4ZTlmNGI2ZjFmNGU4YjVhNzE3NjcwZTBjNzIxYTg5ZmY">Slack</a>. If you have a non-technical inquiry, please <a href="contact.html">send us an email</a>.</p>
</div>
<div class="title">
<i class="dropdown icon"></i> Is Flow open-source? What is the license?</div>
<div class="content">
<p class="transition hidden">Yes! Flow is open-source for public use, and it is licensed under the <a href="https://github.com/flow-project/flow/blob/master/LICENSE.md" target="_blank" >MIT license</a>. </p>
</div>
<div class="title">
<i class="dropdown icon"></i> How can I report a bug if I find a bug?</div>
<div class="content">
<p class="transition hidden">You can report bugs by submitting GitHub issues. To submit a github issue, please <a target="_blank" href="https://github.com/flow-project/flow/issues">click here</a></p>
</div>
<div class="title">
<i class="dropdown icon"></i> I really need to see some tutorials before I start. Do you also have tutorials?</div>
<div class="content">
<p class="transition hidden">Yes! Please check our <a target="_blank" href="tutorial.html">Tutorial Page</a> to get started with deep reinforcement learning and transportation. We also have Python Jupyter Tutorials for Flow.</p>
</div>
<div class="title">
<i class="dropdown icon"></i> I really would like to contribute to this project. How can I do that?</div>
<div class="content">
<p class="transition hidden">Thank you for your interest in contributing to the project Flow. Please Submit your contributions using Github pull requests. <a target="_blank" href="https://github.com/flow-project/flow/pulls">Click here</a> to submit a new pull request.</p>
</div>
<div class="title">
<i class="dropdown icon"></i> Should I cite any paper or give acknowledgements if I use Flow?</div>
<div class="content">
<p class="transition hidden">If you use Flow for academic research, you are highly encouraged to cite this paper:</p>
<p class="transition hidden">C. Wu, A. Kreidieh, K. Parvate, E. Vinitsky, A. Bayen, "Flow: Architecture and Benchmarking for Reinforcement Learning in Traffic Control," CoRR, vol. abs/1710.05465, 2017. Available: <a href="https://arxiv.org/abs/1710.05465" target="_blank">Arxive</a></p>
<p class="transition hidden">If you use the benchmarks, you are highly encouraged to cite this paper:</p>
<p class="transition hidden">E. Vinitsky, A. Kreidieh, L. L. Flem, N. Kheterpal, K. Jang, C. Wu, F. Wu, R. Liaw, E. Liang, A. M. Bayen. "Benchmarks for reinforcement learning in mixed-autonomy traffic". In Conference on Robot Learning (pp. 399-409). Available: <a href="http://proceedings.mlr.press/v87/vinitsky18a.html " target="_blank">PMLR</a></p>
</div>
</div>
</div>
<!--/.container-->
</section>
<section class="font-1">
<div class="container">
<div class="row">
<div class="col-md-12 text-center">
<h3>More Questions?</h3>
<a class="btn btn-primary mt-3" href="contact.html">Contact us</a>
<hr class="short color-8 mb-7 mt-4"> </div>
</div>
<!--/.row-->
</div>
<!--/.container-->
</section>
<script src="assets/js/footer.js"></script>
</main>
<!-- -->
<!-- JavaScripts-->
<!-- =============================================-->
<script src="assets/lib/jquery/dist/jquery.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js"></script>
<script src="assets/lib/bootstrap/dist/js/bootstrap.min.js"></script>
<script src="assets/lib/owl.carousel/dist/owl.carousel.min.js"></script>
<script src="assets/js/core.js"></script>
<script src="assets/js/main.js"></script>
<script src="assets/lib/semantic-ui-transition/transition.js"></script>
<script src="assets/lib/semantic-ui-accordion/accordion.js"></script>
</body>
</html>