Skip to content

Commit

Permalink
refresh docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Guest400123064 committed Oct 11, 2024
1 parent 8cb4958 commit f9a6bec
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
15 changes: 12 additions & 3 deletions docs/ezgatr.html
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,17 @@ <h3 align="center">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" />
<a href="https://github.com/python/mypy"><img src="https://img.shields.io/badge/types-Mypy-blue.svg" alt="types - Mypy" /></a>
<a href="https://guest400123064.github.io/ezgatr/ezgatr.html"><img src="https://img.shields.io/website?label=documentation&up_message=online&url=https%3A%2F%2Fguest400123064.github.io/ezgatr" alt="Website" /></a>
<a href="https://www.python.org/downloads/release/python-3100/"><img src="https://img.shields.io/badge/python-%203.9%20|%203.10%20|%203.11-blue.svg" alt="Python 3.10" /></a></p>
<a href="https://pypi.org/project/ezgatr/"><img src="https://img.shields.io/pypi/v/ezgatr" alt="PyPI" /></a>
<a href="https://www.python.org/downloads/release/python-3100/"><img src="https://img.shields.io/badge/python-%203.9%20|%203.10%20|%203.11-blue.svg" alt="Python 3.10" /></a>
<a href="https://doi.org/10.5281/zenodo.13920438"><img src="https://zenodo.org/badge/836505200.svg" alt="DOI" /></a></p>

<h2 id="what-is-ezgatr">What is EzGATr?</h2>

<p><strong>EzGATr</strong> (Easy Geometric Algebra Transformer) intends to be a simple-to-use and lightweight Python library for building 3D <a href="https://arxiv.org/abs/2305.18415">Geometric Algebra Transformers (GATr)</a>. It is a collection of operators, modules, utilities, etc. build on top of <a href="https://pytorch.org/">PyTorch</a>. In addition, EzGATr also seeks to bridge the gap between the mathematical formulations and corresponding implementations through extensive documentation and explanations to facilitate learning and potential future optimizations.</p>

<h2 id="installation">Installation</h2>

<p>EzGATr is currently in development and not yet available on PyPI. To install it, you can clone the repository and install it using <code>pip</code>. Use the <code>-e</code> flag to install it in editable mode for quick changes.</p>
<p>EzGATr is currently under active development. To install it, you can clone the repository and install it using <code>pip</code>. Use the <code>-e</code> flag to install it in editable mode for making quick changes.</p>

<div class="pdoc-code codehilite">
<pre><span></span><code>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/Guest400123064/ezgatr.git
Expand All @@ -86,6 +88,13 @@ <h2 id="installation">Installation</h2>
</code></pre>
</div>

<p>Alternatively, one can directly install it from PyPI.</p>

<div class="pdoc-code codehilite">
<pre><span></span><code>$<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>ezgatr
</code></pre>
</div>

<h2 id="usage">Usage</h2>

<p>The quick start example shown below demonstrates how to use EzGATr to build a equivariant network with one input/output channel (e.g., a point cloud) and four hidden channels. The mock input data contains a batch of eight samples, each with 256 3D objects embedded as multi-vectors.</p>
Expand Down Expand Up @@ -135,7 +144,7 @@ <h2 id="citation-and-authors">Citation and Authors</h2>

<div class="pdoc-code codehilite">
<pre><span></span><code><span class="nc">@misc</span><span class="p">{</span><span class="nl">ezgatr2024</span><span class="p">,</span>
<span class="w"> </span><span class="na">author</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{Yuxuan Wang, Xiatao, Sun}</span><span class="p">,</span>
<span class="w"> </span><span class="na">author</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{Yuxuan Wang, Xiatao Sun}</span><span class="p">,</span>
<span class="w"> </span><span class="na">title</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{EzGATr: Geometric Algebra Transformer Made Easy}</span><span class="p">,</span>
<span class="w"> </span><span class="na">year</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="m">2024</span><span class="p">,</span>
<span class="w"> </span><span class="na">publisher</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">{Zenodo}</span><span class="p">,</span>
Expand Down
Loading

0 comments on commit f9a6bec

Please sign in to comment.