Skip to content

Commit

Permalink
Deployed e056e7e with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
aelmiger committed Apr 15, 2024
1 parent fb51fd4 commit 795df3a
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions developement/architecture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@
<h1 id="syclops-codebase-architecture">Syclops Codebase Architecture</h1>
<p>The following section provides an overview of the architectural structure of Syclops, helping developers and users understand the interplay between different components.</p>
<h2 id="repository-overview">Repository Overview</h2>
<p><a class="glightbox" data-draggable="True" data-effect="zoom" data-height="auto" data-width="100%" data-zoomable="True" href="/img/docs/syclops_overview.png"><img alt="An overview of how the different repositories work together to create synthetic data in Syclops" src="/img/docs/syclops_overview.png"/></a></p>
<p><a class="glightbox" data-draggable="True" data-effect="zoom" data-height="auto" data-width="100%" data-zoomable="True" href="../../img/docs/syclops_overview.png"><img alt="An overview of how the different repositories work together to create synthetic data in Syclops" src="../../img/docs/syclops_overview.png"/></a></p>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -577,7 +577,7 @@ <h3 id="key-components">Key Components:</h3>
<p>The following is a list of relevant files:</p>
<ul>
<li><strong>syclops</strong><ul>
<li><strong>cli.py</strong>: Contains the code for the syclops <a href="/usage/command_line">CLI interface</a>. It also orchestrates the preprocessing, postprocessing, and starting of Blender for the synthetic data generation.</li>
<li><strong>cli.py</strong>: Contains the code for the syclops <a href="../../usage/command_line/">CLI interface</a>. It also orchestrates the preprocessing, postprocessing, and starting of Blender for the synthetic data generation.</li>
</ul>
</li>
<li><strong>syclops/preprocessing</strong><ul>
Expand Down
Binary file modified sitemap.xml.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion usage/command_line/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -579,7 +579,7 @@ <h1 id="command-line">Command Line</h1>
</tr>
<tr>
<td><code>-d</code></td>
<td>Debugging mode. See <a href="/developement/debugging">Debugging</a></td>
<td>Debugging mode. See <a href="../../developement/debugging/">Debugging</a></td>
<td><code>False</code></td>
<td>String [scene, blender-code, pipeline-code]</td>
</tr>
Expand Down
8 changes: 4 additions & 4 deletions usage/faq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -684,17 +684,17 @@ <h3 id="q-im-having-trouble-installing-syclops-what-should-i-do">Q: I'm having t
<p>A: Make sure you have the correct version of Python installed (3.9 or higher) and that you're using a virtual environment to avoid package conflicts. If you're still having issues, please open an issue on the <a href="https://github.com/DFKI-NI/syclops/issues">GitHub repository</a> with details about your operating system, Python version, and the error messages you're seeing.</p>
<h2 id="assets">Assets</h2>
<h3 id="q-how-do-i-add-new-assets-to-my-project">Q: How do I add new assets to my project?</h3>
<p>A: To add new assets, create an <code>assets.yaml</code> file in your project directory that defines the asset library and its assets. Then, run <code>syclops -c</code> to crawl the assets and update the catalog. For more information, see the <a href="/usage/assets/assets">Assets documentation</a>.</p>
<p>A: To add new assets, create an <code>assets.yaml</code> file in your project directory that defines the asset library and its assets. Then, run <code>syclops -c</code> to crawl the assets and update the catalog. For more information, see the <a href="../assets/assets/">Assets documentation</a>.</p>
<h3 id="q-im-getting-an-error-message-saying-an-asset-file-is-missing-what-should-i-do">Q: I'm getting an error message saying an asset file is missing. What should I do?</h3>
<p>A: Check that the file paths in your <code>assets.yaml</code> file are correct and that the files exist in the specified locations. If you've recently added or moved assets, make sure to run <code>syclops -c</code> to update the asset catalog.</p>
<h2 id="job-configuration">Job Configuration</h2>
<h3 id="q-my-job-configuration-isnt-working-as-expected-how-can-i-debug-it">Q: My job configuration isn't working as expected. How can I debug it?</h3>
<p>A: You can use the <code>-d</code> flag to enable debugging mode in Syclops. Use <code>-d scene</code> to open the scene in Blender for visual debugging, or <code>-d blender-code</code> and <code>-d pipeline-code</code> to debug the Blender and pipeline code, respectively. For more information, see the <a href="/developement/debugging">Debugging documentation</a>.</p>
<p>A: You can use the <code>-d</code> flag to enable debugging mode in Syclops. Use <code>-d scene</code> to open the scene in Blender for visual debugging, or <code>-d blender-code</code> and <code>-d pipeline-code</code> to debug the Blender and pipeline code, respectively. For more information, see the <a href="../../developement/debugging/">Debugging documentation</a>.</p>
<h3 id="q-how-do-i-use-dynamic-evaluators-in-my-job-configuration">Q: How do I use dynamic evaluators in my job configuration?</h3>
<p>A: Dynamic evaluators allow you to randomize parameter values for each frame in your scene. To use them, replace a fixed value in your job configuration with a dynamic evaluator expression, such as <code>uniform: [0, 1]</code> for a uniform random value between 0 and 1. For more examples, see the <a href="/usage/job_description/dynamic_evaluators">Dynamic Evaluators documentation</a>.</p>
<p>A: Dynamic evaluators allow you to randomize parameter values for each frame in your scene. To use them, replace a fixed value in your job configuration with a dynamic evaluator expression, such as <code>uniform: [0, 1]</code> for a uniform random value between 0 and 1. For more examples, see the <a href="../job_description/dynamic_evaluators/">Dynamic Evaluators documentation</a>.</p>
<h2 id="rendering">Rendering</h2>
<h3 id="q-my-renders-are-taking-a-long-time-how-can-i-speed-them-up">Q: My renders are taking a long time. How can I speed them up?</h3>
<p>A: To speed up rendering, you can try reducing the number of samples per pixel in your sensor configuration, or using a lower resolution for your output images. You can also make sure you're using GPU rendering if you have a compatible graphics card. For more tips, see the <a href="/usage/job_description/sensor_configuration">Sensor Configuration documentation</a>.</p>
<p>A: To speed up rendering, you can try reducing the number of samples per pixel in your sensor configuration, or using a lower resolution for your output images. You can also make sure you're using GPU rendering if you have a compatible graphics card. For more tips, see the <a href="../job_description/config_descriptions/camera/">Sensor Configuration documentation</a>.</p>
<h3 id="q-im-getting-artifacts-or-noise-in-my-rendered-images-what-can-i-do">Q: I'm getting artifacts or noise in my rendered images. What can I do?</h3>
<p>A: Increase the number of samples per pixel in your sensor configuration to reduce noise and artifacts. You can also try enabling denoising in your job configuration by setting <code>denoising_enabled: True</code> and choosing an appropriate denoising algorithm, such as <code>OPTIX</code> or <code>OPENIMAGEDENOISE</code>.</p>
<h2 id="postprocessing">Postprocessing</h2>
Expand Down

0 comments on commit 795df3a

Please sign in to comment.