Skip to content

Commit 2effae2

Browse files
denklegithub-actions[bot]mikeheddes
authored
Add intRVFL to the models module (#125)
* Add intRVFL to the models module * [github-action] formatting fixes * Refactor IntRVFL model implementation * [github-action] formatting fixes * Remove reference from all * Added minor revisions * [github-action] formatting fixes * Add ridge regression to functional module * [github-action] formatting fixes * Refactor IntRVFL one-hot transform * [github-action] formatting fixes --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: mikeheddes <mikeheddes@gmail.com>
1 parent b6ae3a5 commit 2effae2

File tree

7 files changed

+300
-262
lines changed

7 files changed

+300
-262
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ The API documentation is divided into several sections:
4242
- [`torchhd`](https://torchhd.readthedocs.io/en/stable/torchhd.html)
4343
- [`torchhd.embeddings`](https://torchhd.readthedocs.io/en/stable/embeddings.html)
4444
- [`torchhd.structures`](https://torchhd.readthedocs.io/en/stable/structures.html)
45+
- [`torchhd.models`](https://torchhd.readthedocs.io/en/stable/models.html)
46+
- [`torchhd.memory`](https://torchhd.readthedocs.io/en/stable/memory.html)
4547
- [`torchhd.datasets`](https://torchhd.readthedocs.io/en/stable/datasets.html)
4648

4749
You can improve the documentation by sending pull requests to this repository.
@@ -104,7 +106,11 @@ We are always looking for people that want to contribute to the library. If you
104106

105107
### Documentation
106108

107-
To build the documentation locally, use `pip install -r docs/requirements.txt` to install the required packages. Then, with `sphinx-build -b html docs build` you can generate the html documentation in the `/build` directory. To create a clean build, remove the `/build` and `/docs/generated` directories.
109+
To build the documentation locally do the following:
110+
1. Use `pip install -r docs/requirements.txt` to install the required packages.
111+
2. Use `sphinx-build -b html docs build` to generate the html documentation in the `/build` directory.
112+
113+
To create a clean build, remove the `/build` and `/docs/generated` directories.
108114

109115
### Creating a New Release
110116

docs/models.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ torchhd.models
1010
:template: class.rst
1111

1212
Centroid
13+
IntRVFL

docs/torchhd.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ Operations
3939
multirandsel
4040
create_random_permute
4141
resonator
42+
ridge_regression
4243
soft_quantize
4344
hard_quantize
4445

0 commit comments

Comments
 (0)