Skip to content

Commit

Permalink
Move model zoo to the website, point contact information to specific …
Browse files Browse the repository at this point in the history
…discussion threads.
  • Loading branch information
qiuwch committed Jan 10, 2017
1 parent d5383c6 commit 97ce1e7
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 38 deletions.
2 changes: 1 addition & 1 deletion docs/game/faster-rcnn.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ After running `faster-rcnn.py`, you are expected to see a message showing the cl

Here we show how to do testing in a virtual scene. If you are interested in training model with synthetic images. Please refer to the tutorial about [generating images](/ipynb/generate-images.md).

If you want the training procedure can also interact with the scene, such as reinforcement learning, please [contact us](/contact.md), we are working on it.
If you want the training procedure can also interact with the scene, such as reinforcement learning, please join the discussion [here](https://groups.google.com/d/topic/unrealcv/0zFjX_DCe7U/discussion), we are working on it.
2 changes: 1 addition & 1 deletion docs/plugin/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This page briefly describes how to install UnrealCV as a UE4 plugin. Make sure y

## Use compiled plugin binary

You can download compiled UnrealCV binaries from our [github release page](https://github.com/unrealcv/unrealcv/releases). Then copy the compiled binaries to the plugins folder to install it. The plugin can support 4.12, 4.13 and 4.14. Compiled binaries are provided for 4.13, if you need a version other than that, you can [send us a request](/contact.md) or build it yourself by following [the instruction](#compile-from-source-code-advanced). You can install the plugin to either a game project or to UE4 engine.
You can download compiled UnrealCV binaries from our [github release page](https://github.com/unrealcv/unrealcv/releases). Then copy the compiled binaries to the plugins folder to install it. The plugin can support 4.12, 4.13 and 4.14. Compiled binaries are provided for 4.13, if you need a version other than that, you can [send us a request](https://unrealcv.org/contact.html) or build it yourself by following [the instruction](#compile-from-source-code-advanced). You can install the plugin to either a game project or to UE4 engine.

- Install to project
- Go to project folder which contains `[ProjectName].uproject`
Expand Down
1 change: 1 addition & 0 deletions docs/reference/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The C++ code of the plugin is documented with doxygen. You can generate the API document with `cd docs/doxygen; doxygen`. An online version is hosted in [here](https://codedocs.xyz/unrealcv/unrealcv/).
2 changes: 1 addition & 1 deletion docs/reference/command.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ UnrealCV provides commands useful for computer vision researchers. What is more,
!!! Note
This command list is growing and subject to change

[Contact us](/contact.md) to tell us what missing functions are needed for your project. We will consider adding it in the future release.
Reply [this thread](https://groups.google.com/d/topic/unrealcv/EuJlibmTN3c/discussion) to tell us what missing functions are needed for your project. We will consider adding it in the future release.

<!-- Do not use table, very hard to extend, this is manually synced from the source code -->

Expand Down
5 changes: 4 additions & 1 deletion docs/reference/issues.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
!!! warning
Under construction

## Known issues

- The speed of UnrealCV

- The OpenEXR requirement


## Issues and workarounds

Issues and workaround can be found in [issue tracker](https://github.com/unrealcv/unrealcv/issues). Please use the search function before posting your issue, your problem might have already been answered. Also you are welcome to chat with us in our [gitter channel](https://gitter.im/unrealcv/unrealcv).
Expand Down
34 changes: 1 addition & 33 deletions docs/reference/model-zoo.md
Original file line number Diff line number Diff line change
@@ -1,33 +1 @@
We provide compiled virtual worlds for researchers to play. Run the downloaded binary.

- In Mac: Run `[ProjectName].app`
- In Linux: Run `./[ProjectName]/Binaries/Linux/[ProjectName]`
- In Windows: Run `[ProjectName]/[ProjectName].exe`

License: all the digital contents belong to the original author. No game assets should be released without the explict permission from the digital creator. If you want to use these game scenes in the UE4 editor in UnrealCV plugin mode, please consider purchasing the source contents.

Disclaimer: the game binaries provided in this page are provided by researchers. The UnrealCV team is not responsible for these binaries.

<!-- If the program crash for any reason, you can report [an issue](https://github.com/unrealcv/unrealcv/issues) to us. -->
<!-- add more formal license information -->

<!-- The community maintained games will be hosted in the [github wiki page](http://). -->


## [RealisticRendering](https://docs.unrealengine.com/latest/INT/Resources/Showcases/RealisticRendering/)
<div id="realistic_rendering"></div>

**Preview:**
![teaser](/images/realistic_rendering.png)

**Description:**

Realistic Rendering is a demo created by Epic Games to show the rendering power of Unreal Engine 4. Here we provide an extended version of this demo with UnrealCV embedded.

**Download:**

- [Windows](http://www.cs.jhu.edu/~qiuwch/unrealcv/binaries//RealisticRendering-Win64-65d6144-171cd97.zip)

- [Linux](http://www.cs.jhu.edu/~qiuwch/unrealcv/binaries//RealisticRendering-Linux-65d6144-171cd97.zip) (Tested in Ubuntu 14.04)

- [Mac](http://www.cs.jhu.edu/~qiuwch/unrealcv/binaries//RealisticRendering-Mac-65d6144-c25660b.zip)
Please see [the model zoo page](http://unrealcv.org/reference/model_zoo.html).
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ pages:
- "Model zoo": reference/model-zoo.md
- "API docs": reference/api.md
- "Issues": reference/issues.md
- "Contact": contact.md
extra:
version: v0.3.0
codebase: https://github.com/unrealcv/unrealcv

0 comments on commit 97ce1e7

Please sign in to comment.