Skip to content

Commit

Permalink
Merge pull request #32 from FangJiangyi/master
Browse files Browse the repository at this point in the history 
update docs
  • Loading branch information
@FangJiangyi
FangJiangyi authored Jul 11, 2023
2 parents 0f3e955 + 1ce1151 commit 2141df9
Show file tree
Hide file tree
Showing 56 changed files with 4,621 additions and 108 deletions.
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/md_file/all_results.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/md_file/introduction.doctree
View file
Binary file not shown.
Binary file added docs/.doctrees/md_file/predictive_tool.doctree
View file
Binary file not shown.
Binary file added docs/.doctrees/md_file/urban_dataset.doctree
View file
Binary file not shown.
Binary file added docs/.doctrees/md_file/visualization_tool.doctree
View file
Binary file not shown.
12 changes: 6 additions & 6 deletions docs/APIReference.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="UCTB documentation" href="index.html"/>
<link rel="next" title="5.1. UCTB.dataset package" href="UCTB.dataset.html"/>
<link rel="prev" title="4. Tutorial" href="md_file/tutorial.html"/>
<link rel="prev" title="4. Visualization Tool" href="md_file/visualization_tool.html"/>


<script src="_static/js/modernizr.min.js"></script>
Expand Down Expand Up @@ -84,9 +84,9 @@

<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="md_file/introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/installation.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/quickstart.html">3. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/tutorial.html">4. Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/urban_dataset.html">2. Urban Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/predictive_tool.html">3. Predictive Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/visualization_tool.html">4. Visualization Tool</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">5. API Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="UCTB.dataset.html">5.1. UCTB.dataset package</a></li>
<li class="toctree-l2"><a class="reference internal" href="UCTB.preprocess.html">5.2. UCTB.preprocess package</a></li>
Expand All @@ -97,7 +97,7 @@
<li class="toctree-l2"><a class="reference internal" href="UCTB.utils.html">5.7. UCTB.utils package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Results on different datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Benchmark Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/uctb_group.html">7. About us (UCTB Group)</a></li>
</ul>

Expand Down Expand Up @@ -224,7 +224,7 @@ <h1><span class="section-number">5. </span>API Reference<a class="headerlink" hr
<a href="UCTB.dataset.html" class="btn btn-neutral float-right" title="5.1. UCTB.dataset package" accesskey="n">Next →</a>


<a href="md_file/tutorial.html" class="btn btn-neutral" title="4. Tutorial" accesskey="p">← Previous</a>
<a href="md_file/visualization_tool.html" class="btn btn-neutral" title="4. Visualization Tool" accesskey="p">← Previous</a>

</div>

Expand Down
8 changes: 4 additions & 4 deletions docs/UCTB.dataset.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="md_file/introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/installation.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/quickstart.html">3. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/tutorial.html">4. Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/urban_dataset.html">2. Urban Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/predictive_tool.html">3. Predictive Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/visualization_tool.html">4. Visualization Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIReference.html">5. API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Results on different datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Benchmark Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/uctb_group.html">7. About us (UCTB Group)</a></li>
</ul>

Expand Down
8 changes: 4 additions & 4 deletions docs/UCTB.evaluation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="md_file/introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/installation.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/quickstart.html">3. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/tutorial.html">4. Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/urban_dataset.html">2. Urban Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/predictive_tool.html">3. Predictive Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/visualization_tool.html">4. Visualization Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIReference.html">5. API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Results on different datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Benchmark Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/uctb_group.html">7. About us (UCTB Group)</a></li>
</ul>

Expand Down
8 changes: 4 additions & 4 deletions docs/UCTB.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="md_file/introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/installation.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/quickstart.html">3. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/tutorial.html">4. Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/urban_dataset.html">2. Urban Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/predictive_tool.html">3. Predictive Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/visualization_tool.html">4. Visualization Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIReference.html">5. API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Results on different datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Benchmark Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/uctb_group.html">7. About us (UCTB Group)</a></li>
</ul>

Expand Down
8 changes: 4 additions & 4 deletions docs/UCTB.model.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="md_file/introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/installation.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/quickstart.html">3. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/tutorial.html">4. Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/urban_dataset.html">2. Urban Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/predictive_tool.html">3. Predictive Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/visualization_tool.html">4. Visualization Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIReference.html">5. API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Results on different datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Benchmark Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/uctb_group.html">7. About us (UCTB Group)</a></li>
</ul>

Expand Down
8 changes: 4 additions & 4 deletions docs/UCTB.model_unit.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="md_file/introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/installation.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/quickstart.html">3. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/tutorial.html">4. Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/urban_dataset.html">2. Urban Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/predictive_tool.html">3. Predictive Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/visualization_tool.html">4. Visualization Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIReference.html">5. API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Results on different datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Benchmark Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/uctb_group.html">7. About us (UCTB Group)</a></li>
</ul>

Expand Down
8 changes: 4 additions & 4 deletions docs/UCTB.preprocess.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="md_file/introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/installation.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/quickstart.html">3. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/tutorial.html">4. Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/urban_dataset.html">2. Urban Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/predictive_tool.html">3. Predictive Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/visualization_tool.html">4. Visualization Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIReference.html">5. API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Results on different datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Benchmark Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/uctb_group.html">7. About us (UCTB Group)</a></li>
</ul>

Expand Down
8 changes: 4 additions & 4 deletions docs/UCTB.train.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,11 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="md_file/introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/installation.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/quickstart.html">3. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/tutorial.html">4. Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/urban_dataset.html">2. Urban Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/predictive_tool.html">3. Predictive Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/visualization_tool.html">4. Visualization Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIReference.html">5. API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Results on different datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Benchmark Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/uctb_group.html">7. About us (UCTB Group)</a></li>
</ul>

Expand Down
12 changes: 6 additions & 6 deletions docs/UCTB.utils.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="UCTB documentation" href="index.html"/>
<link rel="up" title="5. API Reference" href="APIReference.html"/>
<link rel="next" title="6. Results on different datasets" href="md_file/all_results.html"/>
<link rel="next" title="6. Benchmark Results" href="md_file/all_results.html"/>
<link rel="prev" title="5.6. UCTB.train package" href="UCTB.train.html"/>


Expand Down Expand Up @@ -85,11 +85,11 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="md_file/introduction.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/installation.html">2. Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/quickstart.html">3. Quick start</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/tutorial.html">4. Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/urban_dataset.html">2. Urban Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/predictive_tool.html">3. Predictive Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/visualization_tool.html">4. Visualization Tool</a></li>
<li class="toctree-l1"><a class="reference internal" href="APIReference.html">5. API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Results on different datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/all_results.html">6. Benchmark Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="md_file/uctb_group.html">7. About us (UCTB Group)</a></li>
</ul>

Expand Down Expand Up @@ -186,7 +186,7 @@ <h1><span class="section-number">5.7. </span>UCTB.utils package<a class="headerl

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="md_file/all_results.html" class="btn btn-neutral float-right" title="6. Results on different datasets" accesskey="n">Next →</a>
<a href="md_file/all_results.html" class="btn btn-neutral float-right" title="6. Benchmark Results" accesskey="n">Next →</a>


<a href="UCTB.train.html" class="btn btn-neutral" title="5.6. UCTB.train package" accesskey="p">← Previous</a>
Expand Down
Binary file added docs/_images/Pedestrain_Melbourne.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/Raw_data.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/XGBoost_Result.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/adjacent_matrix_visualization.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/data_reassemble.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/denormalized_data.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/normalized_data.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ Welcome to UCTB's documentation!

md_file/introduction.md

md_file/installation.md
md_file/urban_dataset.md

md_file/quickstart.md
md_file/predictive_tool.md

md_file/tutorial.md
md_file/visualization_tool.md

APIReference.rst

Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/md_file/all_results.md.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Results on different datasets
# Benchmark Results

## STMeta Version

Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/md_file/introduction.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ UCTB also releases [a public dataset repository](https://github.com/uctb/Urban-D

We provide [detailed documents](https://github.com/uctb/Urban-Dataset/blob/main/Tutorial/tutorial.ipynb) about how to build and how to use these datasets.

### Prediction Models
### Predictive Tool

Currently, the package supports the following models: (This toolbox is constructed based on some open-source repos. We appreciate these awesome implements. [See more details](https://uctb.github.io/UCTB/md_file/static/current_supported_models.html)).

Expand Down
Loading

0 comments on commit 2141df9

Please sign in to comment.