Skip to content

Commit 5780907

Browse files
committed
addd doc 0415
1 parent 475fe14 commit 5780907

File tree

690 files changed

+49641
-42708
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

690 files changed

+49641
-42708
lines changed

docs/_images/data_visualization1.png

763 KB
Loading

docs/_images/data_visualization2.png

46.9 KB
Loading

docs/_images/data_visualization3.png

127 KB
Loading

docs/_images/pipeline.png

-13.4 KB
Binary file not shown.

docs/_images/tensorboard.png

90.2 KB
Loading

docs/_modules/index.html

+53-5
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,14 @@
8181

8282

8383

84-
<p class="caption"><span class="caption-text">Get Started</span></p>
84+
<p><span class="caption-text">Get Started</span></p>
8585
<ul>
8686
<li class="toctree-l1"><a class="reference internal" href="../get_started/introduction.html">Introduction</a></li>
8787
<li class="toctree-l1"><a class="reference internal" href="../get_started/install.html">Install LibCity</a></li>
8888
<li class="toctree-l1"><a class="reference internal" href="../get_started/quick_start.html">Quick Start</a></li>
8989
<li class="toctree-l1"><a class="reference internal" href="../get_started/directory_structure.html">Directory Structure</a></li>
9090
</ul>
91-
<p class="caption"><span class="caption-text">User Guide</span></p>
91+
<p><span class="caption-text">User Guide</span></p>
9292
<ul>
9393
<li class="toctree-l1"><a class="reference internal" href="../user_guide/config_settings.html">Config Settings</a></li>
9494
<li class="toctree-l1"><a class="reference internal" href="../user_guide/data.html">Data Introduction</a></li>
@@ -97,21 +97,22 @@
9797
<li class="toctree-l1"><a class="reference internal" href="../user_guide/executor.html">Executor Introduction</a></li>
9898
<li class="toctree-l1"><a class="reference internal" href="../user_guide/usage.html">Usage</a></li>
9999
</ul>
100-
<p class="caption"><span class="caption-text">Developer Guide</span></p>
100+
<p><span class="caption-text">Developer Guide</span></p>
101101
<ul>
102102
<li class="toctree-l1"><a class="reference internal" href="../developer_guide/code_style.html">Code Style</a></li>
103103
<li class="toctree-l1"><a class="reference internal" href="../developer_guide/implemented_datasets.html">Customize Dataset</a></li>
104104
<li class="toctree-l1"><a class="reference internal" href="../developer_guide/implemented_models.html">Customize Models</a></li>
105105
<li class="toctree-l1"><a class="reference internal" href="../developer_guide/implemented_executors.html">Customize Executors</a></li>
106106
</ul>
107-
<p class="caption"><span class="caption-text">Tutorial</span></p>
107+
<p><span class="caption-text">Tutorial</span></p>
108108
<ul>
109109
<li class="toctree-l1"><a class="reference internal" href="../tutorial/install_quick_start.html">Install and quick start</a></li>
110110
<li class="toctree-l1"><a class="reference internal" href="../tutorial/run_model.html">Run an existing model in LibCity</a></li>
111111
<li class="toctree-l1"><a class="reference internal" href="../tutorial/add_model.html">Add a new model to LibCity</a></li>
112112
<li class="toctree-l1"><a class="reference internal" href="../tutorial/hyper_tune.html">Tuning the model with automatic tool</a></li>
113+
<li class="toctree-l1"><a class="reference internal" href="../tutorial/data_visualization.html">Visualize Atomic Files</a></li>
113114
</ul>
114-
<p class="caption"><span class="caption-text">API REFERENCE</span></p>
115+
<p><span class="caption-text">API REFERENCE</span></p>
115116
<ul>
116117
<li class="toctree-l1"><a class="reference internal" href="../libcity/libcity.config.html">libcity.config</a></li>
117118
<li class="toctree-l1"><a class="reference internal" href="../libcity/libcity.data.html">libcity.data</a></li>
@@ -190,7 +191,33 @@ <h1>All modules for which code is available</h1>
190191
<li><a href="libcity/data/dataset/ccrnn_dataset.html">libcity.data.dataset.ccrnn_dataset</a></li>
191192
<li><a href="libcity/data/dataset/convgcn_dataset.html">libcity.data.dataset.convgcn_dataset</a></li>
192193
<li><a href="libcity/data/dataset/crann_dataset.html">libcity.data.dataset.crann_dataset</a></li>
194+
<li><a href="libcity/data/dataset/dataset_subclass/acfm_dataset.html">libcity.data.dataset.dataset_subclass.acfm_dataset</a></li>
195+
<li><a href="libcity/data/dataset/dataset_subclass/astgcn_dataset.html">libcity.data.dataset.dataset_subclass.astgcn_dataset</a></li>
196+
<li><a href="libcity/data/dataset/dataset_subclass/ccrnn_dataset.html">libcity.data.dataset.dataset_subclass.ccrnn_dataset</a></li>
197+
<li><a href="libcity/data/dataset/dataset_subclass/chebconv_dataset.html">libcity.data.dataset.dataset_subclass.chebconv_dataset</a></li>
198+
<li><a href="libcity/data/dataset/dataset_subclass/convgcn_dataset.html">libcity.data.dataset.dataset_subclass.convgcn_dataset</a></li>
199+
<li><a href="libcity/data/dataset/dataset_subclass/crann_dataset.html">libcity.data.dataset.dataset_subclass.crann_dataset</a></li>
200+
<li><a href="libcity/data/dataset/dataset_subclass/cstn_dataset.html">libcity.data.dataset.dataset_subclass.cstn_dataset</a></li>
201+
<li><a href="libcity/data/dataset/dataset_subclass/dmvstnet_dataset.html">libcity.data.dataset.dataset_subclass.dmvstnet_dataset</a></li>
202+
<li><a href="libcity/data/dataset/dataset_subclass/geosan_dataset.html">libcity.data.dataset.dataset_subclass.geosan_dataset</a></li>
203+
<li><a href="libcity/data/dataset/dataset_subclass/gman_dataset.html">libcity.data.dataset.dataset_subclass.gman_dataset</a></li>
204+
<li><a href="libcity/data/dataset/dataset_subclass/gsnet_dataset.html">libcity.data.dataset.dataset_subclass.gsnet_dataset</a></li>
205+
<li><a href="libcity/data/dataset/dataset_subclass/gts_dataset.html">libcity.data.dataset.dataset_subclass.gts_dataset</a></li>
206+
<li><a href="libcity/data/dataset/dataset_subclass/hgcn_dataset.html">libcity.data.dataset.dataset_subclass.hgcn_dataset</a></li>
207+
<li><a href="libcity/data/dataset/dataset_subclass/line_dataset.html">libcity.data.dataset.dataset_subclass.line_dataset</a></li>
208+
<li><a href="libcity/data/dataset/dataset_subclass/multi_stgcnet_dataset.html">libcity.data.dataset.dataset_subclass.multi_stgcnet_dataset</a></li>
209+
<li><a href="libcity/data/dataset/dataset_subclass/pbs_trajectory_dataset.html">libcity.data.dataset.dataset_subclass.pbs_trajectory_dataset</a></li>
210+
<li><a href="libcity/data/dataset/dataset_subclass/reslstm_dataset.html">libcity.data.dataset.dataset_subclass.reslstm_dataset</a></li>
211+
<li><a href="libcity/data/dataset/dataset_subclass/staggcn_dataset.html">libcity.data.dataset.dataset_subclass.staggcn_dataset</a></li>
212+
<li><a href="libcity/data/dataset/dataset_subclass/stdn_dataset.html">libcity.data.dataset.dataset_subclass.stdn_dataset</a></li>
213+
<li><a href="libcity/data/dataset/dataset_subclass/stg2seq_dataset.html">libcity.data.dataset.dataset_subclass.stg2seq_dataset</a></li>
214+
<li><a href="libcity/data/dataset/dataset_subclass/stresnet_dataset.html">libcity.data.dataset.dataset_subclass.stresnet_dataset</a></li>
215+
<li><a href="libcity/data/dataset/dataset_subclass/tgclstm_dataset.html">libcity.data.dataset.dataset_subclass.tgclstm_dataset</a></li>
193216
<li><a href="libcity/data/dataset/dmvstnet_dataset.html">libcity.data.dataset.dmvstnet_dataset</a></li>
217+
<li><a href="libcity/data/dataset/eta_dataset.html">libcity.data.dataset.eta_dataset</a></li>
218+
<li><a href="libcity/data/dataset/eta_encoder/abstract_eta_encoder.html">libcity.data.dataset.eta_encoder.abstract_eta_encoder</a></li>
219+
<li><a href="libcity/data/dataset/eta_encoder/deeptte_encoder.html">libcity.data.dataset.eta_encoder.deeptte_encoder</a></li>
220+
<li><a href="libcity/data/dataset/eta_encoder/ttpnet_encoder.html">libcity.data.dataset.eta_encoder.ttpnet_encoder</a></li>
194221
<li><a href="libcity/data/dataset/geosan_dataset.html">libcity.data.dataset.geosan_dataset</a></li>
195222
<li><a href="libcity/data/dataset/gman_dataset.html">libcity.data.dataset.gman_dataset</a></li>
196223
<li><a href="libcity/data/dataset/gts_dataset.html">libcity.data.dataset.gts_dataset</a></li>
@@ -199,6 +226,7 @@ <h1>All modules for which code is available</h1>
199226
<li><a href="libcity/data/dataset/multi_stgcnet_dataset.html">libcity.data.dataset.multi_stgcnet_dataset</a></li>
200227
<li><a href="libcity/data/dataset/pbs_trajectory_dataset.html">libcity.data.dataset.pbs_trajectory_dataset</a></li>
201228
<li><a href="libcity/data/dataset/reslstm_dataset.html">libcity.data.dataset.reslstm_dataset</a></li>
229+
<li><a href="libcity/data/dataset/roadnetwork_dataset.html">libcity.data.dataset.roadnetwork_dataset</a></li>
202230
<li><a href="libcity/data/dataset/staggcn_dataset.html">libcity.data.dataset.staggcn_dataset</a></li>
203231
<li><a href="libcity/data/dataset/stdn_dataset.html">libcity.data.dataset.stdn_dataset</a></li>
204232
<li><a href="libcity/data/dataset/stg2seq_dataset.html">libcity.data.dataset.stg2seq_dataset</a></li>
@@ -224,28 +252,45 @@ <h1>All modules for which code is available</h1>
224252
<li><a href="libcity/data/utils.html">libcity.data.utils</a></li>
225253
<li><a href="libcity/evaluator/abstract_evaluator.html">libcity.evaluator.abstract_evaluator</a></li>
226254
<li><a href="libcity/evaluator/cara_loc_pred_evaluator.html">libcity.evaluator.cara_loc_pred_evaluator</a></li>
255+
<li><a href="libcity/evaluator/eta_evaluator.html">libcity.evaluator.eta_evaluator</a></li>
227256
<li><a href="libcity/evaluator/eval_funcs.html">libcity.evaluator.eval_funcs</a></li>
228257
<li><a href="libcity/evaluator/geosan_evaluator.html">libcity.evaluator.geosan_evaluator</a></li>
229258
<li><a href="libcity/evaluator/map_matching_evaluator.html">libcity.evaluator.map_matching_evaluator</a></li>
259+
<li><a href="libcity/evaluator/road_representation_evaluator.html">libcity.evaluator.road_representation_evaluator</a></li>
260+
<li><a href="libcity/evaluator/traffic_accident_evaluator.html">libcity.evaluator.traffic_accident_evaluator</a></li>
230261
<li><a href="libcity/evaluator/traffic_state_evaluator.html">libcity.evaluator.traffic_state_evaluator</a></li>
231262
<li><a href="libcity/evaluator/traj_loc_pred_evaluator.html">libcity.evaluator.traj_loc_pred_evaluator</a></li>
232263
<li><a href="libcity/evaluator/utils.html">libcity.evaluator.utils</a></li>
233264
<li><a href="libcity/executor/abstract_executor.html">libcity.executor.abstract_executor</a></li>
234265
<li><a href="libcity/executor/abstract_tradition_executor.html">libcity.executor.abstract_tradition_executor</a></li>
266+
<li><a href="libcity/executor/chebconv_executor.html">libcity.executor.chebconv_executor</a></li>
235267
<li><a href="libcity/executor/dcrnn_executor.html">libcity.executor.dcrnn_executor</a></li>
268+
<li><a href="libcity/executor/eta_executor.html">libcity.executor.eta_executor</a></li>
236269
<li><a href="libcity/executor/geml_executor.html">libcity.executor.geml_executor</a></li>
270+
<li><a href="libcity/executor/gensim_executor.html">libcity.executor.gensim_executor</a></li>
237271
<li><a href="libcity/executor/geosan_executor.html">libcity.executor.geosan_executor</a></li>
238272
<li><a href="libcity/executor/hyper_tuning.html">libcity.executor.hyper_tuning</a></li>
273+
<li><a href="libcity/executor/line_executor.html">libcity.executor.line_executor</a></li>
239274
<li><a href="libcity/executor/map_matching_executor.html">libcity.executor.map_matching_executor</a></li>
240275
<li><a href="libcity/executor/mtgnn_executor.html">libcity.executor.mtgnn_executor</a></li>
241276
<li><a href="libcity/executor/traffic_state_executor.html">libcity.executor.traffic_state_executor</a></li>
242277
<li><a href="libcity/executor/traj_loc_pred_executor.html">libcity.executor.traj_loc_pred_executor</a></li>
243278
<li><a href="libcity/model/abstract_model.html">libcity.model.abstract_model</a></li>
244279
<li><a href="libcity/model/abstract_traffic_state_model.html">libcity.model.abstract_traffic_state_model</a></li>
245280
<li><a href="libcity/model/abstract_traffic_tradition_model.html">libcity.model.abstract_traffic_tradition_model</a></li>
281+
<li><a href="libcity/model/eta/DeepTTE.html">libcity.model.eta.DeepTTE</a></li>
282+
<li><a href="libcity/model/eta/TTPNet.html">libcity.model.eta.TTPNet</a></li>
246283
<li><a href="libcity/model/loss.html">libcity.model.loss</a></li>
284+
<li><a href="libcity/model/map_matching/HMMM.html">libcity.model.map_matching.HMMM</a></li>
247285
<li><a href="libcity/model/map_matching/IVMM.html">libcity.model.map_matching.IVMM</a></li>
248286
<li><a href="libcity/model/map_matching/STMatching.html">libcity.model.map_matching.STMatching</a></li>
287+
<li><a href="libcity/model/road_representation/ChebConv.html">libcity.model.road_representation.ChebConv</a></li>
288+
<li><a href="libcity/model/road_representation/DeepWalk.html">libcity.model.road_representation.DeepWalk</a></li>
289+
<li><a href="libcity/model/road_representation/GAT.html">libcity.model.road_representation.GAT</a></li>
290+
<li><a href="libcity/model/road_representation/GeomGCN.html">libcity.model.road_representation.GeomGCN</a></li>
291+
<li><a href="libcity/model/road_representation/LINE.html">libcity.model.road_representation.LINE</a></li>
292+
<li><a href="libcity/model/road_representation/Node2Vec.html">libcity.model.road_representation.Node2Vec</a></li>
293+
<li><a href="libcity/model/traffic_accident_prediction/GSNet.html">libcity.model.traffic_accident_prediction.GSNet</a></li>
249294
<li><a href="libcity/model/traffic_demand_prediction/CCRNN.html">libcity.model.traffic_demand_prediction.CCRNN</a></li>
250295
<li><a href="libcity/model/traffic_demand_prediction/DMVSTNet.html">libcity.model.traffic_demand_prediction.DMVSTNet</a></li>
251296
<li><a href="libcity/model/traffic_demand_prediction/STG2Seq.html">libcity.model.traffic_demand_prediction.STG2Seq</a></li>
@@ -270,6 +315,7 @@ <h1>All modules for which code is available</h1>
270315
<li><a href="libcity/model/traffic_flow_prediction/STResNetCommon.html">libcity.model.traffic_flow_prediction.STResNetCommon</a></li>
271316
<li><a href="libcity/model/traffic_flow_prediction/STSGCN.html">libcity.model.traffic_flow_prediction.STSGCN</a></li>
272317
<li><a href="libcity/model/traffic_flow_prediction/ToGCN.html">libcity.model.traffic_flow_prediction.ToGCN</a></li>
318+
<li><a href="libcity/model/traffic_od_prediction/CSTN.html">libcity.model.traffic_od_prediction.CSTN</a></li>
273319
<li><a href="libcity/model/traffic_od_prediction/GEML.html">libcity.model.traffic_od_prediction.GEML</a></li>
274320
<li><a href="libcity/model/traffic_speed_prediction/ATDM.html">libcity.model.traffic_speed_prediction.ATDM</a></li>
275321
<li><a href="libcity/model/traffic_speed_prediction/AutoEncoder.html">libcity.model.traffic_speed_prediction.AutoEncoder</a></li>
@@ -302,12 +348,14 @@ <h1>All modules for which code is available</h1>
302348
<li><a href="libcity/model/trajectory_loc_prediction/STAN.html">libcity.model.trajectory_loc_prediction.STAN</a></li>
303349
<li><a href="libcity/model/trajectory_loc_prediction/STRNN.html">libcity.model.trajectory_loc_prediction.STRNN</a></li>
304350
<li><a href="libcity/model/trajectory_loc_prediction/TemplateTLP.html">libcity.model.trajectory_loc_prediction.TemplateTLP</a></li>
351+
<li><a href="libcity/model/utils.html">libcity.model.utils</a></li>
305352
<li><a href="libcity/pipeline/pipeline.html">libcity.pipeline.pipeline</a></li>
306353
<li><a href="libcity/utils/GPS_utils.html">libcity.utils.GPS_utils</a></li>
307354
<li><a href="libcity/utils/argument_list.html">libcity.utils.argument_list</a></li>
308355
<li><a href="libcity/utils/dataset.html">libcity.utils.dataset</a></li>
309356
<li><a href="libcity/utils/normalization.html">libcity.utils.normalization</a></li>
310357
<li><a href="libcity/utils/utils.html">libcity.utils.utils</a></li>
358+
<li><a href="libcity/utils/visualize.html">libcity.utils.visualize</a></li>
311359
</ul>
312360

313361
</div>

0 commit comments

Comments
 (0)