Skip to content

Commit

Permalink
docs and index update
Browse files Browse the repository at this point in the history
  • Loading branch information
mkumar73 committed May 31, 2024
1 parent 6871f38 commit 63656de
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 18 deletions.
23 changes: 6 additions & 17 deletions docs/introduction.md → docs/homepage.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,6 @@ Mambular is a Python package that brings the power of Mamba architectures to tab
- **Sklearn-like API**: The familiar scikit-learn `fit`, `predict`, and `predict_proba` methods mean minimal learning curve for those already accustomed to scikit-learn.
- **PyTorch Lightning Under the Hood**: Built on top of PyTorch Lightning, Mambular models benefit from streamlined training processes, easy customization, and advanced features like distributed training and 16-bit precision.

## Documentation

You can find the Mamba-Tabular API documentation [here](https://mambular.readthedocs.io/en/latest/).

## Installation

Install Mambular using pip:
```sh
pip install mambular
```

## Preprocessing

Expand Down Expand Up @@ -137,16 +127,15 @@ model.fit(

```

## Citation
## Citing Mambular

If you find this project useful in your research or in scientific publication, please consider citing it in your references.

If you find this project useful in your research, please consider cite:
```BibTeX
@misc{2024,
@software{mambular2024,
title={Mambular: Tabular Deep Learning with Mamba Architectures},
author={Anton Frederik Thielmann, Soheila Samiee, Christoph Weisser, Benjamin Saefken'},
howpublished = {\url{https://github.com/basf/mamba-tabular}},
author={Anton Frederik Thielmann, Soheila Samiee, Christoph Weisser, Benjamin Saefken, Manish Kumar},
url = {https://github.com/basf/mamba-tabular},
year={2024}
}
```

## License
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. mdinclude:: introduction.md
.. mdinclude:: homepage.md

.. toctree::
:name: Getting Started
Expand Down

0 comments on commit 63656de

Please sign in to comment.