PageSourceSearch

https://flow-project.github.io/usingFlow.html

html flow-project.github.io collected 2026-10-03 09:12:07 UTC 11,130 bytes, 160 lines download raw bytes

1<!DOCTYPE html>
2<html lang="en-US">
3    <head>
4        <meta charset="utf-8">
5        <meta http-equiv="X-UA-Compatible" content="IE=edge">
6        <meta name="viewport" content="width=device-width, initial-scale=1">
7        <!--  -->
8        <!--    Document Title-->
9        <!-- =============================================-->
10        <title>Using Flow</title>
11        <!--  -->
12        <!--    Favicons-->
13        <!--    =============================================-->
14        
14<script src="assets/js/favicon.js"></script>
14
15        <meta name="theme-color" content="#ffffff">
16        <!--  -->
17        <!--    Stylesheets-->
18        <!--    =============================================-->
19        <!-- Default stylesheets-->
20        <link href="assets/lib/bootstrap/dist/css/bootstrap.min.css" rel="stylesheet">
21        <!-- Template specific stylesheets-->
22        <link href="https://fonts.googleapis.com/css?family=Montserrat:100,300,400,600" rel="stylesheet">
23        <link href="https://fonts.googleapis.com/css?family=Droid+Serif:400,400i" rel="stylesheet">
24        <link href="assets/lib/font-awesome/css/font-awesome.min.css" rel="stylesheet">
25        <link href="assets/lib/iconsmind/iconsmind.css" rel="stylesheet">
26        <link href="assets/lib/css-hamburgers/dist/hamburgers.css" rel="stylesheet">
27        <link href="assets/lib/owl.carousel/dist/assets/owl.carousel.min.css" rel="stylesheet">
28        <link href="assets/lib/owl.carousel/dist/assets/owl.theme.default.min.css" rel="stylesheet">
29        <link href="assets/lib/semantic-ui-transition/transition.css" rel="stylesheet"/>
30        <link href="assets/lib/semantic-ui-accordion/accordion.css" rel="stylesheet">
31        <!-- Main stylesheet and color file-->
32        <link href="assets/css/style.css" rel="stylesheet">
33        <link href="assets/css/custom.css" rel="stylesheet"> </head>
34    <body data-spy="scroll" data-target=".inner-link" data-offset="60">
35        <main>
36            
36<script src="assets/js/header.js"></script>
36
37            
38            
39            <section class="text-center background-11 font-1">
40                <div class="container">
41                    <div class="row justify-content-center">
42                        <div class="col-lg-8">
43                            <h3 class="color-1 mb-4">Using Flow</h3>
44                            <p class="color-4 lead">Flow is available open-source for public use</p>
45                            <a href="https://github.com/flow-project/flow" class="btn btn-icon btn-primary btn-icon-left" target="_blank">
46                                <span class="fa fa-github">
47                                </span> Download from Github
48                            </a>
49                            <hr class="short mb-8 color-8 mt-4"> 
50                        </div>
51                        
52                    </div>
53                    <div class="row">
54                        <div class="col-sm-12">
55                            <p class="color-4 lead">Flow can be installed in 2 ways</p>
56                        </div>
57                        <div class="col-sm-6">
58                            <p class="color-4 lead"> <b>locally</b> on your computer</p>
59                            <a href="https://flow.readthedocs.io/en/latest/flow_setup.html#local-installation" class="btn btn btn-outline-dark" target="_blank">
60      Local Installation
61                            </a>
62                        </div>
63                        <div class="col-sm-6">
64                            <p class="color-4 lead"><b>virtually</b> from an image.</p>
65                            <a href="https://flow.readthedocs.io/en/latest/flow_setup.html#remote-installation-using-docker" class="btn btn btn-outline-dark" target="_blank">
66                               Virtual Installation
67                            </a>
68                        </div>
69                        <hr class="short mb-8 color-8 mt-4"> 
70                    </div>
71           
72
73                    <h4 class="color-1 mb-4" id="faq">FAQ</h4>
74                       <div class="ui styled fluid accordion text-left">
75                            <div class="title">
76                                <i class="dropdown icon"></i> What is Flow?</div>
77                            <div class="content">
78                                <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>
79                            </div>
80                           <div class="title">
81                                <i class="dropdown icon"></i> Is there any installation instructions?</div>
82                            <div class="content">
83                                <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>
84                            </div>
85                           <div class="title">
86                                <i class="dropdown icon"></i> Does Flow have proper documentation?</div>
87                            <div class="content">
88                                <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>
89                            </div>
90                           <div class="title active">
91                                <i class="dropdown icon"></i> How can I ask my questions?</div>
92                            <div class="content active">
93                                <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>
94                            </div>
95                            <div class="title">
96                                <i class="dropdown icon"></i> Is Flow open-source? What is the license?</div>
97                            <div class="content">
98                                <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>
99                            </div>
100                            <div class="title">
101                                <i class="dropdown icon"></i>
101 How can I report a bug if I find a bug?</div>
102                            <div class="content">
103                                <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>
104                            </div>
105                           <div class="title">
106                                <i class="dropdown icon"></i> I really need to see some tutorials before I start. Do you also have tutorials?</div>
107                            <div class="content">
108                                <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>
109                            </div>
110                           <div class="title">
111                                <i class="dropdown icon"></i> I really would like to contribute to this project. How can I do that?</div>
112                            <div class="content">
113                                <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>
114                            </div>
115                            <div class="title">
116                                <i class="dropdown icon"></i> Should I cite any paper or give acknowledgements if I use Flow?</div>
117                            <div class="content">
118                                <p class="transition hidden">If you use Flow for academic research, you are highly encouraged to cite this paper:</p>
119
120                                <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>
121
122                                <p class="transition hidden">If you use the benchmarks, you are highly encouraged to cite this paper:</p>
123
124                                <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>
125                            </div>
126                           
127                   </div>
128                </div>
129                <!--/.container-->
130            </section>
131            <section class="font-1">
132                <div class="container">
133                    <div class="row">
134                        <div class="col-md-12 text-center">
135                            <h3>More Questions?</h3>
136                            <a class="btn btn-primary mt-3" href="contact.html">Contact us</a>
137                            
138                            <hr class="short color-8 mb-7 mt-4"> </div>
139                    </div>
140                    
141                    <!--/.row-->
142                </div>
143                <!--/.container-->
144            </section>
145           
146            
146<script src="assets/js/footer.js"></script>
146
147        </main>
148        <!--  -->
149        <!--    JavaScripts-->
150        <!--    =============================================-->
151        
151<script src="assets/lib/jquery/dist/jquery.js"></script>
151
152        
152<script src="https://cdnjs.cloudflare.com/ajax/libs/tether/1.4.0/js/tether.min.js"></script>
152
153        
153<script src="assets/lib/bootstrap/dist/js/bootstrap.min.js"></script>
153
154        
154<script src="assets/lib/owl.carousel/dist/owl.carousel.min.js"></script>
154
155        
155<script src="assets/js/core.js"></script>
155
156        
156<script src="assets/js/main.js"></script>
156
157        
157<script src="assets/lib/semantic-ui-transition/transition.js"></script>
157
158        
158<script src="assets/lib/semantic-ui-accordion/accordion.js"></script>
158
159    </body>
160</html>

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.