GitHub to Huggingface

.gitignore

@@ -0,0 +1,9 @@
+target/
+.venv/
+
+.DS_Store
+.idea/
+.vscode/
+
+*.log
+*.tmp

LICENSE

@@ -0,0 +1,374 @@
+Mozilla Public License Version 2.0
+==================================
+LunaStev. FlowModel Project
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

README.md

@@ -1,3 +1,136 @@
+# FlowModel
+
+FlowModel is a lightweight and extensible machine learning framework designed for beginners who want to explore AI development. With its modular plugin-based architecture, users can easily extend its functionality while keeping the core simple and maintainable.
+
 ---
-license: mpl-2.0
+
+## Table of Contents
+1. [Introduction](#introduction)
+2. [Installation](#installation)
+3. [Directory Structure](#directory-structure)
+4. [Usage](#usage)
+    - [Training a Model](#training-a-model)
+    - [Adding Plugins](#adding-plugins)
+5. [Creating Plugins](#creating-plugins)
+6. [Command-Line Interface](#command-line-interface)
+7. [Contributing](#contributing)
+8. [License](#license)
+
 ---
+
+## Introduction
+FlowModel provides a simple entry point for experimenting with AI and machine learning. It allows users to start with a minimal framework and extend it by creating and adding plugins. The framework is designed to focus on simplicity, modularity, and extensibility.
+
+---
+
+## Installation
+
+### Prerequisites
+- Python 3.8 or higher
+- `pip` package manager
+
+### Steps
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/LunaStev/FlowModel.git
+   cd FlowModel
+   ```
+
+2. Create and activate a virtual environment:
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # For Unix/MacOS
+   .venv\Scripts\activate   # For Windows
+   ```
+
+3. Install dependencies:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+---
+
+## Directory Structure
+```plaintext
+FlowModel/
+├── main.py             # Entry point for the application
+├── plugins/            # Directory for plugins
+│   ├── __init__.py     # Initializes the plugin package
+│   ├── example_plugin.py # Example plugin
+├── data/               # Placeholder for datasets
+├── requirements.txt    # Python dependencies
+```
+
+---
+
+## Usage
+
+### Training a Model
+To train a model using FlowModel, run:
+```bash
+python main.py train
+```
+This will load any available plugins from the `plugins/` directory and apply their logic during the training process.
+
+### Adding Plugins
+To add a plugin, place a `.py` file with your plugin class in the `plugins/` directory. FlowModel automatically detects and loads plugins at runtime.
+
+---
+
+## Creating Plugins
+Plugins extend the functionality of FlowModel. To create a plugin:
+
+1. **Create a new Python file in the `plugins/` directory**:
+   ```bash
+   plugins/my_plugin.py
+   ```
+
+2. **Define your plugin class**:
+   ```python
+   class MyPlugin:
+       def __init__(self):
+           print("MyPlugin initialized.")
+
+       def modify_model(self, model):
+           print("MyPlugin: Modifying the model.")
+           return model
+
+       def on_train_start(self):
+           print("MyPlugin: Training started.")
+
+       def on_train_end(self):
+           print("MyPlugin: Training finished.")
+   ```
+
+3. **Use your plugin during training**:
+   When `main.py` runs, it automatically loads your plugin and calls its methods.
+
+---
+
+## Command-Line Interface
+FlowModel includes a simple CLI for interacting with the framework.
+
+### Commands
+- **Train**: Start the training process with plugins.
+  ```bash
+  python main.py train
+  ```
+
+---
+
+## Contributing
+Contributions are welcome! To contribute:
+1. Fork the repository.
+2. Create a new branch for your feature.
+3. Commit your changes and push them.
+4. Open a pull request.
+
+---
+
+## License
+FlowModel is released under the MPL-2.0 License. See [LICENSE](LICENSE) for details.
+
+---
+
+Happy experimenting with FlowModel! 🚀
+

core/model.py

@@ -0,0 +1,15 @@
+import torch.nn as nn
+
+class FlowModel:
+    def __init__(self):
+        self.model = None
+
+    def build_model(self):
+        self.model = nn.Sequential(
+            nn.Linear(28*28, 128),
+            nn.ReLU(),
+            nn.Linear(128, 10)
+        )
+
+    def get_model(self):
+        return self.model

core/predictor.py

@@ -0,0 +1,17 @@
+import torch
+
+class Predictor:
+    def __init__(self, model):
+        self.model = model
+
+    def predict(self, test_loader):
+        self.model.eval()
+        predictions = []
+
+        with torch.no_grad():
+            for images, _ in test_loader:
+                outputs = self.model(images.view(-1, 28 * 28))
+                _, predicted = torch.max(outputs, 1)
+                predictions.extend(predicted.cpu().numpy())
+
+        return predictions

core/trainer.py

@@ -0,0 +1,19 @@
+import torch.optim as optim
+import torch.nn as nn
+
+class Trainer:
+    def __init__(self, model):
+        self.model = model
+        self.criterion = nn.CrossEntropyLoss()
+        self.optimizer = optim.SGD(self.model.parameters(), lr=0.01)
+
+    def train(self, train_loader, epochs=5):
+        for epoch in range(epochs):
+            for images, labels in train_loader:
+                self.optimizer.zero_grad()
+                outputs = self.model(images.view(-1, 28*28))
+                loss = self.criterion(outputs, labels)
+                loss.backward()
+                self.optimizer.step()
+
+            print(f"Epoch [{epoch+1}/{epochs}], Loss: {loss.item():.4f}")

data/example_data.py

@@ -0,0 +1,13 @@
+from torchvision import datasets, transforms
+from torch.utils.data import DataLoader
+
+
+def load_mnist():
+    transform = transforms.Compose([transforms.ToTensor(), transforms.Normalize((0.5,), (0.5,))])
+    train_dataset = datasets.MNIST(root='./data', train=True, download=True, transform=transform)
+    test_dataset = datasets.MNIST(root='./data', train=False, download=True, transform=transform)
+
+    train_loader = DataLoader(train_dataset, batch_size=64, shuffle=True)
+    test_loader = DataLoader(test_dataset, batch_size=64, shuffle=False)
+
+    return {'train': train_loader, 'test': test_loader}

main.py

@@ -0,0 +1,84 @@
+import argparse
+import os
+import importlib
+
+def check_plugins(loaded_plugins):
+    print("Loaded plugins:")
+    for plugin in loaded_plugins:
+        print(f"- {plugin}")
+
+
+def train_model(dataset_name, plugins):
+    dataset = {'train': []}  # Placeholder for training data
+
+    model = "FlowModel"
+
+    for plugin in plugins:
+        if hasattr(plugin, 'modify_model'):
+            model = plugin.modify_model(model)
+
+    for plugin in plugins:
+        if hasattr(plugin, 'on_train_start'):
+            plugin.on_train_start()
+
+    print(f"Training started on dataset: {dataset_name}")
+
+    for plugin in plugins:
+        if hasattr(plugin, 'on_train_end'):
+            plugin.on_train_end()
+
+    print("Training finished.")
+
+
+def load_plugins():
+    plugins_dir = './plugins'
+    plugins = []
+
+    if not os.path.exists(plugins_dir):
+        os.makedirs(plugins_dir)
+        print(f"Plugins directory created at {plugins_dir}. Add your plugins there!")
+
+    for filename in os.listdir(plugins_dir):
+        if filename.endswith('.py') and filename != '__init__.py':
+            plugin_name = filename[:-3]
+            try:
+                plugin_module = importlib.import_module(f'plugins.{plugin_name}')
+                plugin_class = getattr(plugin_module, plugin_name.title().replace('_', ''), None)
+                if plugin_class:
+                    plugins.append(plugin_class())
+                    print(f"Plugin {plugin_name} loaded.")
+                else:
+                    print(f"No class found in plugin {plugin_name}.")
+            except Exception as e:
+                print(f"Failed to load plugin {plugin_name}: {e}")
+
+    return plugins
+
+
+def predict_model(plugins):
+    print("Prediction started.")
+    for plugin in plugins:
+        if hasattr(plugin, 'on_predict'):
+            plugin.on_predict()
+    print("Prediction finished.")
+
+
+def main():
+    parser = argparse.ArgumentParser(description="FlowModel CLI")
+    parser.add_argument('command', choices=['train', 'predict', 'check_plugins'], help="Command to run")
+
+    args = parser.parse_args()
+
+    plugins, loaded_plugins = load_plugins()
+
+    if args.command == 'train':
+        plugins = load_plugins()
+        train_model("mnist", plugins)
+    elif args.command == 'predict':
+        predict_model(plugins)
+    elif args.command == 'check_plugins':
+        check_plugins(loaded_plugins)
+
+
+if __name__ == "__main__":
+    main()

plugins/example_plugin.py

@@ -0,0 +1,13 @@
+class ExamplePlugin:
+    def __init__(self):
+        print("ExamplePlugin initialized.")
+
+    def modify_model(self, model):
+        print("ExamplePlugin: Modifying the model.")
+        return f"{model}_modified_by_example"
+
+    def on_train_start(self):
+        print("ExamplePlugin: Training started.")
+
+    def on_train_end(self):
+        print("ExamplePlugin: Training finished.")

plugins/sample_plugin.py

@@ -0,0 +1,13 @@
+class SamplePlugin:
+    def __init__(self):
+        print("SamplePlugin initialized.")
+
+    def modify_model(self, model):
+        print("SamplePlugin: Modifying the model.")
+        return model
+
+    def on_train_start(self):
+        print("SamplePlugin: Training started.")
+
+    def on_train_end(self):
+        print("SamplePlugin: Training finished.")

requirements.txt

@@ -0,0 +1,3 @@
+torch==2.5.1
+numpy==2.2.1
+torchvision==0.20.1