readthedocs added

.readthedocs.yaml

@@ -0,0 +1,45 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Define the build environment settings
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Define the steps required to install the project's dependencies
+python:
+  install:
+    - requirements: requirements.txt  # Install project dependencies
+    - requirements: docs/requirements.txt  # Install documentation dependencies
+
+# Optionally, define additional formats to build (e.g., PDF, ePub)
+formats:
+  - pdf
+  - epub
+
+# Custom settings for the Read the Docs build process
+# conda:  # Optional, if your project requires conda environments
+#   file: environment.yml
+
+# Optionally, define commands to be executed before or after the build
+# For example, to generate additional API documentation using Sphinx
+# build:
+#   jobs:
+#     post_sphinx:
+#       - sphinx-apidoc -o docs/source/ my_package
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt
+   - method: pip
+     path: .

README.md

@@ -1,10 +1,15 @@
 # PyxLSTM
 
-![Banner](docs/images/xlstm-logo-v2.png)
+![Banner](assets/xlstm-logo-v2.png)
 
-[![GitHub stars](https://img.shields.io/github/stars/muditbhargava66/PyxLSTM)](https://github.com/muditbhargava66/PyxLSTM/stargazers)
+![Python Version](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-blue)
 [![GitHub license](https://img.shields.io/github/license/muditbhargava66/PyxLSTM)](https://github.com/muditbhargava66/PyxLSTM/blob/main/LICENSE)
-[![Python version](https://img.shields.io/badge/python-3.6%2B-blue)](https://www.python.org/downloads/)
+[![Documentation Status](https://readthedocs.org/projects/pyxlstm/badge/?version=latest)](https://pyxlstm.readthedocs.io/en/latest/?badge=latest)
+![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)
+[![GitHub stars](https://img.shields.io/github/stars/muditbhargava66/PyxLSTM)](https://github.com/muditbhargava66/PyxLSTM/stargazers)
+![GitHub Releases](https://img.shields.io/github/downloads/muditbhargava66/PyxLSTM/total)
+![Last Commit](https://img.shields.io/github/last-commit/muditbhargava66/PyxLSTM)
+
 
 PyxLSTM is a Python library that provides an efficient and extensible implementation of the Extended Long Short-Term Memory (xLSTM) architecture based on the research paper ["xLSTM: Extended Long Short-Term Memory"](https://arxiv.org/abs/2405.04517) by Beck et al. (2024). xLSTM enhances the traditional LSTM by introducing exponential gating, memory mixing, and a matrix memory structure, enabling improved performance and scalability for sequence modeling tasks.
 

docs/conf.py

@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../src'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'PyxlSTM'
+copyright = '2024, Mudit Bhargava'
+author = 'Mudit Bhargava'
+
+# The full version, including alpha/beta/rc tags
+release = 'v2.0.0'
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+    'sphinxcontrib.applehelp',
+    'myst_parser',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The master toctree document.
+master_doc = 'index'
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Additional settings for myst-parser
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}

docs/index.rst

@@ -0,0 +1,24 @@
+.. PyxlSTM documentation master file, created by
+   sphinx-quickstart on Thu Jun 28.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PyxlSTM's documentation!
+===========================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   mlstm.md
+   slstm.md
+   training.md
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx>=5.0
+sphinx_rtd_theme
+myst-parser
+sphinxcontrib-applehelp

pyproject.toml

@@ -43,7 +43,8 @@ dev = [
 
 [project.urls]
 Homepage = "https://github.com/muditbhargava66/PyxLSTM"
-Repository = "https://github.com/muditbhargava66/PyxLSTM"
+Documentation = "https://PyxLSTM.readthedocs.io/"
+Repository = "https://github.com/muditbhargava66/PyxLSTM.git"
 Issues = "https://github.com/muditbhargava66/PyxLSTM/issues"
 
 [project.license]