# VisualTorch Documentation

VisualTorch aims to help visualize Torch-based neural network architectures. It currently supports generating layered-style, graph-style, and LeNet-style architectures for PyTorch Sequential and Custom models.

![VisualTorch](_static/images/banners/visualizations-preview.png)

## {octicon}`rocket` Get Started

::::{grid}

:::{grid-item-card} Installation
:link: markdown/get_started/installation
:link-type: doc

Installing visualtorch via PyPI or Source.
:::

::::

## {octicon}`eye` Usage Examples

::::{grid}

:::{grid-item-card} All Examples
:link: usage_examples/index
:link-type: doc

Usage examples of VisualTorch.
:::

::::

## {octicon}`code-square` API References

::::{grid}

:::{grid-item-card} All API References
:link: markdown/api_references/index
:link-type: doc

API references of VisualTorch.
:::

::::

## {octicon}`book` Developer Guides

::::{grid}

:::{grid-item-card} Contributing to VisualTorch
:link: markdown/developer_guides/contributing
:link-type: doc

How to contribute, prepare the development environment, test, report issues, and seek support.
:::

::::

## {octicon}`bookmark` Citation

Please cite this project in your publications if it helps your research as follows:

```{literalinclude} snippets/citation/bib.txt
:language: bibtex
```

```{toctree}
:caption: Get Started
:hidden:

markdown/get_started/installation
```

```{toctree}
:caption: Usage Examples
:hidden:

usage_examples/layered/index
usage_examples/graph/index
usage_examples/lenet_style/index
```

```{toctree}
:caption: API References
:hidden:

markdown/api_references/layered
markdown/api_references/graph
markdown/api_references/lenet_style

```

```{toctree}
:caption: Developer Guides
:hidden:

markdown/developer_guides/contributing
```

```{toctree}
:caption: License
:hidden:

markdown/license/index
```