torchfoundry 0.1.1__py3-none-any.whl

torchfoundry/data.py

@@ -0,0 +1,47 @@
+from typing import Literal
+
+from torch.utils.data import DataLoader
+
+Selector=Literal["train","test"]
+
+def loadDataset(selector:Selector| None=None, batch_size: int=64):
+    """
+    Get a FashionMNIST DataLoader.
+
+    Parameters
+    ----------
+    selector : {"train", "test"} or None, default=None
+        Select which dataset to return.
+        None returns both DataLoaders.
+
+    batch_size : int, default=64
+        Number of samples per batch (1-128).
+
+    Returns
+    -------
+    DataLoader or tuple[training_data, testing_data]
+        The selected DataLoader, or both DataLoaders.
+    """
+    if type(batch_size) is not int:
+        raise ValueError("batch_size must be an integer")
+    if not 0 < batch_size < 128:
+        raise ValueError("batch_size must be between 1 and 128")
+
+    trainData= "not finished"
+    testData="not finished"
+    raise ValueError("still in development")
+
+    if selector =="train": 
+        training_data= DataLoader(trainData,batch_size=batch_size, shuffle=True)
+        return training_data
+    elif selector =="test":
+        testing_data= DataLoader(testData, batch_size=batch_size, shuffle=True)
+        return testing_data
+    elif selector is None:
+        training_data= DataLoader(trainData,batch_size=batch_size, shuffle=True) 
+        testing_data= DataLoader(testData, batch_size=batch_size, shuffle=True)
+        return training_data, testing_data
+    else:
+        raise ValueError("selector must have value { test / train / None }")
+        
+

torchfoundry/model.py

@@ -0,0 +1,93 @@
+from pathlib import Path
+from typing import Literal
+
+import torch
+from rich import print
+from torch import nn
+from torchinfo import summary
+
+Summary=Literal[True,False]
+def loadModel(layers,load_dict=None,Summary: bool=False, input_size=None):
+    """
+       Creates a PyTorch neural network and optionally loads pretrained weights
+    and displays a model summary.
+
+    Args:
+        layers (list[nn.Module]): PyTorch layers used to construct the model.
+        path (str | None): Path to a saved model state dictionary.
+        Summary (bool): Whether to display the model summary.
+        input_size (tuple | None): Dimensions of the model input, excluding
+            the batch dimension. Required if Summary is True.
+
+    Returns:
+        nn.Module: The constructed neural network.
+
+    Raises:
+        ValueError: If the path or input_size is invalid.
+        FileNotFoundError: If the checkpoint file does not exist.
+    """
+
+    #model device runtime 
+    if torch.accelerator.is_available():
+        device=torch.accelerator.current_accelerator
+    else:
+        device='cpu'
+
+    class NeuralNetwork(nn.Module):
+        def __init__(self):
+            super().__init__()
+
+            self.layers=nn.Sequential(*layers)
+
+        def forward(self,x):
+            x=self.layers(x)
+            return x
+
+    model =NeuralNetwork().to(device)
+
+    #loading model
+    if load_dict is not None:
+
+        if not isinstance(load_dict, str):
+            raise ValueError("[red]path parameter must be string[/red]")
+        model_path= Path(load_dict)
+
+        if model_path.exists():
+            print("loading model..." ,flush=True)
+            model.load_state_dict(
+                torch.load(
+                    model_path,
+                    map_location=device,
+                    weights_only=True
+                )
+            )
+
+            print("model created")
+        else:
+            print("[red]model path not found[/red]. Starting fresh")
+
+    #printing the model summary
+    if Summary:
+        if input_size is None:
+            raise ValueError("input_size canot be None when Summary is True")
+        summary(
+            model,
+            input_size=input_size,
+            col_names=["input_size","output_size","num_params","trainable"],
+            depth=1
+        )
+    
+    return model
+
+def  saveModel(model,path):
+    if not model:
+        raise ValueError("model is a required parameter")
+    if not path:
+        raise ValueError("path is a required parameter")
+    if not isinstance(path, (str,Path)):
+        raise ValueError("path must be string or pathlib.Path")
+    if not isinstance(model, nn.Module):
+        raise ValueError("module must be a Pytorch nn.Module")
+
+    torch.save(model.state_dict(),path)
+    print(f"model saved at: {path} ")

torchfoundry/training.py

@@ -0,0 +1,54 @@
+import torch
+from torch import nn
+from torch.utils.data import DataLoader
+
+
+def trainModel(model, dataloader, loss_fn, optimizer, epoch, save_dict=None ):
+
+    if not isinstance(model, nn.Module):
+        raise TypeError("module must be a Pytorch nn.Module")
+    if not isinstance(dataloader,DataLoader):
+        raise TypeError(
+            "dataloader must be an instance of torch.utils.data.DataLoader"
+        )
+    if not isinstance(epoch,int):
+        raise ValueError("epoch must be integer")
+    if not isinstance(save_dict, str):
+        raise ValueError("save_dict must be string")
+
+    if torch.accelerator.is_available():
+        device=torch.accelerator.current_accelerator
+    else:
+        device="cpu"
+    
+    size=len(dataloader.dataset)
+
+    model.train()
+    for e in range(epoch):
+        print("")
+        print(f"epoch:{e+1}")
+        for batch, (x,y) in enumerate(dataloader):
+            x=x.to(device)
+            y=y.to(device)
+
+            pred=model(x)
+            loss=loss_fn(pred,y)
+
+            optimizer.zero_grad()
+            loss.backward()
+            optimizer.step()
+
+            if batch % 100==0:
+                loss=loss.item()
+                current=(batch+1)*len(x)
+
+                print(f"loss: {loss:>7f} [{current:>5d}/{size:>5d}]")
+                
+    if save_dict is not None:
+        try:
+            torch.save(model.state_dict(), save_dict)
+            print(f"model was saved at '{save_dict}'")
+        except (OSError, RuntimeError) as e:
+            raise RuntimeError(f"Failed to save model state_dict: {e}") from e
+
+

torchfoundry-0.1.1.dist-info/METADATA

@@ -0,0 +1,55 @@
+Metadata-Version: 2.4
+Name: torchfoundry
+Version: 0.1.1
+Summary: Beginner-friendly utilities for building and training PyTorch models.
+Author: Lorik Bajrami
+License-Expression: MIT
+Keywords: pytorch,machine-learning,deep-learning,training,data-science
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch
+Requires-Dist: torchinfo
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Dynamic: license-file
+
+# ⚒️ TorchFoundry
+
+**find your PyTorch workflow.**
+
+TorchFoundry is a Python library designed to simplify and improve everyday workflows when working with PyTorch.
+It aims to provide reusable utilities that reduce repetitive code and make machine learning development more convenient.
+Make PyTorch development simpler, more reusable, and easier to maintain.
+
+### 🎓 Built for Learning
+TorchFoundry was created with beginners in mind.
+
+Especially those who want to get into the flow of training machine learning models without being overwhelmed by the complexity that can come with getting started.
+The goal is to make the first steps into model development more approachable, allowing learners to focus on understanding the workflow and gradually build confidence in working with PyTorch.
+
+However, simplification comes with trade-offs. 
+Abstracting away complexity can introduce limitations and hide implementation details that are important to understand. TorchFoundry is intended as a starting point, not a replacement for learning the underlying concepts. Anyone serious about exploring machine learning should investigate these limitations, understand what happens behind the abstractions, and learn when a more hands-on approach is necessary.
+
+### 🛠️ Built With
+
+* Python
+* PyTorch
+
+### 🚧 Project Status
+
+TorchFoundry is currently under development. Features, functionality, and APIs are subject to change.
+
+### 📄 License
+
+License information will be added as the project develops.

torchfoundry-0.1.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+torchfoundry/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+torchfoundry/data.py,sha256=-t2sQul1_AVpnPcl22TXB8H5xzDvAZnQpY3_JC5TXFw,1544
+torchfoundry/model.py,sha256=fYLjtlzZsWFJEVppKE-87AdGz1AWXBhBrl7ydKO_4qk,2877
+torchfoundry/training.py,sha256=gOBsiBPc9tdm1SAP_nqcsZiACch9Anprr_kkxX7hP28,1633
+torchfoundry-0.1.1.dist-info/licenses/LICENSE,sha256=GnX9_IwdaK49eje8WkbowdBE1E49IKUMw4EPQfBq8nw,1086
+torchfoundry-0.1.1.dist-info/METADATA,sha256=LAIhgy7MpZT2zTdS2GeLL-_LXMI8stnHuMWrSI-1K30,2509
+torchfoundry-0.1.1.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+torchfoundry-0.1.1.dist-info/top_level.txt,sha256=LvTk8ts_3Q9ZThECSWfs5tqgd-vgLL9hf-G0B-3oeQo,13
+torchfoundry-0.1.1.dist-info/RECORD,,

torchfoundry-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

torchfoundry-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 lorik440
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

torchfoundry-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+torchfoundry