Merge pull request #2 from lazarust/basic-neural-network-classifier

Adds basic classifier, docs, and more

Author: lazarust

.DS_Store

@@ -160,3 +160,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# Ignoring this file since it's mainly used for local development using Zed
+pyrightconfig.json

.gitignore

@@ -5,14 +5,3 @@ repos:
       - id: ruff
         args: [--fix]
       - id: ruff-format
-  - repo: https://github.com/jazzband/pip-tools
-    rev: 7.4.1
-    hooks:
-      - id: pip-compile
-        name: pip-compile requirements-dev.in
-        args: [requirements-dev.in]
-        files: ^requirements-dev\.(in|txt)$
-      - id: pip-compile
-        name: pip-compile requirements.in
-        args: [requirements.in]
-        files: ^requirements\.(in|txt)$

.pre-commit-config.yaml

@@ -0,0 +1 @@
+3.11

.python-version

@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: docs-requirements.txt

.readthedocs.yaml

@@ -3,7 +3,7 @@
 A scikit-learn compatible neural network library that wraps MLX.
 Highly inspired by [skorch](https://github.com/skorch-dev/skorch).
 
-> [!WARNING]  
+> [!WARNING]
 > This is still under development and non of the following examples actually work.
 
 ## Examples
@@ -40,8 +40,6 @@ net = NeuralNetClassifier(
     MyModule,
     max_epochs=10,
     lr=0.1,
-    # Shuffle training data on each epoch
-    iterator_train__shuffle=True,
 )
 
 net.fit(X, y)

README.md

@@ -0,0 +1,2 @@
+mkdocs>=1.6.1
+mkdocs-material>=9.5.42

docs-requirements.in

@@ -0,0 +1,75 @@
+# This file was autogenerated by uv via the following command:
+#    uv pip compile docs-requirements.in -o docs-requirements.txt
+babel==2.16.0
+    # via mkdocs-material
+certifi==2024.8.30
+    # via requests
+charset-normalizer==3.4.0
+    # via requests
+click==8.1.7
+    # via mkdocs
+colorama==0.4.6
+    # via mkdocs-material
+ghp-import==2.1.0
+    # via mkdocs
+idna==3.10
+    # via requests
+jinja2==3.1.4
+    # via
+    #   mkdocs
+    #   mkdocs-material
+markdown==3.7
+    # via
+    #   mkdocs
+    #   mkdocs-material
+    #   pymdown-extensions
+markupsafe==3.0.2
+    # via
+    #   jinja2
+    #   mkdocs
+mergedeep==1.3.4
+    # via
+    #   mkdocs
+    #   mkdocs-get-deps
+mkdocs==1.6.1
+    # via
+    #   -r docs-requirements.in
+    #   mkdocs-material
+mkdocs-get-deps==0.2.0
+    # via mkdocs
+mkdocs-material==9.5.42
+    # via -r docs-requirements.in
+mkdocs-material-extensions==1.3.1
+    # via mkdocs-material
+packaging==24.1
+    # via mkdocs
+paginate==0.5.7
+    # via mkdocs-material
+pathspec==0.12.1
+    # via mkdocs
+platformdirs==4.3.6
+    # via mkdocs-get-deps
+pygments==2.18.0
+    # via mkdocs-material
+pymdown-extensions==10.11.2
+    # via mkdocs-material
+python-dateutil==2.9.0.post0
+    # via ghp-import
+pyyaml==6.0.2
+    # via
+    #   mkdocs
+    #   mkdocs-get-deps
+    #   pymdown-extensions
+    #   pyyaml-env-tag
+pyyaml-env-tag==0.1
+    # via mkdocs
+regex==2024.9.11
+    # via mkdocs-material
+requests==2.32.3
+    # via mkdocs-material
+six==1.16.0
+    # via python-dateutil
+urllib3==2.2.3
+    # via requests
+watchdog==5.0.3
+    # via mkdocs

docs-requirements.txt

@@ -0,0 +1,3 @@
+# Welcome to SKLX
+
+These docs are still very much under construction!