caf.brain 0.1.0__tar.gz

caf_brain-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+Copyright © Transport for the North (“TfN”) (2025).
+
+
+Use of this software and associated documentation files (“the Software”) by you indicates your acceptance of the terms and conditions below (“the Licence”).
+We make available the Software to you on the basis of this Licence. We do not sell the Software to you. We remain the owners of the Software at all times. 
+
+We grant you a non-exclusive, worldwide, royalty-free, perpetual licence:
+(a)	to use the Software;
+(b)	to develop, modify and maintain the Software;
+(c)	copy, publish, distribute and transmit the Software;
+(d)	adapt the Software.
+
+Where you do any of the above you must acknowledge the source of the Software in your product or application by including or linking the following attribution statement in a prominent and noticeable location in or in the context of your product or application:
+“Outputs derived from CAF.Brain (the Common Analytical Framework AI Toolkit), developed by Transport for the North [https://github.com/Transport-for-the-North/caf.brain]”
+
+Any adaptations applied to the Software before application should be briefly described alongside the above citation. We encourage you to submit to us any adaptations to the Software and where you choose to do so your submissions will be considered for integration into the Software.
+
+The above are important conditions of this Licence and if you fail to comply with them the rights granted to you under this Licence will end automatically. 
+This Licence does not grant you any right to use the Software in a way that suggests any official status or that we endorse you or your use of the Software.
+The Software is licenced 'as is' and we exclude all representations, warranties, obligations and liabilities in relation to the Software to the maximum extent permitted by law.
+We are not liable for any errors or omissions in the Software and shall not be liable for any loss, injury or damage of any kind caused by its use. We do not guarantee the continued supply of the Software.
+This Licence is governed by the laws of the jurisdiction in which we have our principal place of business.

caf_brain-0.1.0/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: caf.brain
+Version: 0.1.0
+Summary: Common Analytical Framework package of Machine and Deep Learning tools.
+Author: Transport for the North
+License: Copyright © Transport for the North (“TfN”) (2025).
+        
+        
+        Use of this software and associated documentation files (“the Software”) by you indicates your acceptance of the terms and conditions below (“the Licence”).
+        We make available the Software to you on the basis of this Licence. We do not sell the Software to you. We remain the owners of the Software at all times. 
+        
+        We grant you a non-exclusive, worldwide, royalty-free, perpetual licence:
+        (a)	to use the Software;
+        (b)	to develop, modify and maintain the Software;
+        (c)	copy, publish, distribute and transmit the Software;
+        (d)	adapt the Software.
+        
+        Where you do any of the above you must acknowledge the source of the Software in your product or application by including or linking the following attribution statement in a prominent and noticeable location in or in the context of your product or application:
+        “Outputs derived from CAF.Brain (the Common Analytical Framework AI Toolkit), developed by Transport for the North [https://github.com/Transport-for-the-North/caf.brain]”
+        
+        Any adaptations applied to the Software before application should be briefly described alongside the above citation. We encourage you to submit to us any adaptations to the Software and where you choose to do so your submissions will be considered for integration into the Software.
+        
+        The above are important conditions of this Licence and if you fail to comply with them the rights granted to you under this Licence will end automatically. 
+        This Licence does not grant you any right to use the Software in a way that suggests any official status or that we endorse you or your use of the Software.
+        The Software is licenced 'as is' and we exclude all representations, warranties, obligations and liabilities in relation to the Software to the maximum extent permitted by law.
+        We are not liable for any errors or omissions in the Software and shall not be liable for any loss, injury or damage of any kind caused by its use. We do not guarantee the continued supply of the Software.
+        This Licence is governed by the laws of the jurisdiction in which we have our principal place of business.
+        
+Project-URL: Bug Tracker, https://github.com/transport-for-the-north/caf.brain/issues
+Project-URL: Homepage, https://github.com/transport-for-the-north/caf.brain
+Project-URL: Source, https://github.com/transport-for-the-north/caf.brain
+Project-URL: Documentation, https://cafbrain.readthedocs.io/
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: caf.toolkit>=0.9.0
+Requires-Dist: joblib>=1.4.2
+Requires-Dist: matplotlib>=3.8.4
+Requires-Dist: mlxtend>=0.23.1
+Requires-Dist: numpy>=1.23.3
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: PyYAML>=6.0.2
+Requires-Dist: scikit-learn>=1.6.1
+Requires-Dist: scipy>=1.15.1
+Requires-Dist: seaborn>=0.13.2
+Requires-Dist: statsmodels>=0.14.0
+Requires-Dist: tqdm>=4.66.2
+Provides-Extra: dev
+Requires-Dist: black>=24; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: mypy_extensions>=1.0.0; extra == "dev"
+Requires-Dist: pydocstyle[toml]>=6.3; extra == "dev"
+Requires-Dist: pylint>=3.2; extra == "dev"
+Requires-Dist: isort>=5.13; extra == "dev"
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.6; extra == "dev"
+Requires-Dist: versioningit>=3.1; extra == "dev"
+Provides-Extra: vision
+Requires-Dist: geopandas>=1.0.1; extra == "vision"
+Requires-Dist: albumentations>=2.0.8; extra == "vision"
+Requires-Dist: beautifulsoup4>=4.12.3; extra == "vision"
+Requires-Dist: dbfread>=2.0.7; extra == "vision"
+Requires-Dist: optuna>=4.4.0; extra == "vision"
+Requires-Dist: Pillow>=11.3.0; extra == "vision"
+Requires-Dist: pyproj>=3.7.1; extra == "vision"
+Requires-Dist: rasterio>=1.4.3; extra == "vision"
+Requires-Dist: ray>=2.48.0; extra == "vision"
+Requires-Dist: tensorflow>=2.10.0; extra == "vision"
+Requires-Dist: torch>=2.8.0; extra == "vision"
+Requires-Dist: ultralytics>=8.3.175; extra == "vision"
+Dynamic: license-file
+
+![Transport for the North Logo](https://github.com/transport-for-the-north/caf.brain/blob/main/docs/TFN_Landscape_Colour_CMYK.png)
+
+<h1 align="center">CAF.brAIn</h1>
+
+<p align="center">
+<a href="https://transport-for-the-north.github.io/CAF-Handbook/python_tools/framework.html">
+  <img alt="CAF Status - Pre-Alpha" src="https://img.shields.io/badge/CAF%20Status-Pre--Alpha-orange">
+</a>
+<a href="https://pypi.org/project/caf.brain/">
+  <img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/caf.brain.svg?style=flat-square">
+</a>
+<a href="https://pypi.org/project/caf.brain/">
+  <img alt="Latest release" src="https://img.shields.io/github/release/transport-for-the-north/caf.brain.svg?style=flat-square&maxAge=86400">
+</a>
+<a href="https://anaconda.org/conda-forge/caf.brain">
+  <img alt="Conda" src="https://img.shields.io/conda/v/conda-forge/caf.brain?style=flat-square&logo=condaforge">
+</a>
+</p>
+<p align="center">
+<a href="https://app.codecov.io/gh/transport-for-the-north/caf.brain">
+  <img alt="Coverage" src="https://img.shields.io/codecov/c/github/transport-for-the-north/caf.brain.svg?branch=main&style=flat-square&logo=CodeCov">
+</a>
+<a href="https://github.com/transport-for-the-north/caf.brain/actions?query=event%3Apush">
+  <img alt="Testing Badge" src="https://img.shields.io/github/actions/workflow/status/transport-for-the-north/caf.brain/tests.yml?style=flat-square&logo=GitHub&label=Tests">
+</a>
+<a href='https://cafbrain.readthedocs.io/en/stable/?badge=stable'>
+  <img alt='Documentation Status' src="https://img.shields.io/readthedocs/cafbrain?style=flat-square&logo=readthedocs">
+</a>
+<a href="https://github.com/psf/black">
+  <img alt="code style: black" src="https://img.shields.io/badge/code%20format-black-000000.svg">
+</a>
+</p>
+
+> [!WARNING]  
+> This package is in an early stage of development so features may change or be removed. 
+> If using this package it is recommended to set a specific version and check before 
+> upgrading to a new version.
+
+Common Analytical Framework package of Machine and Deep Learning tools.
+
+
+
+## Common Analytical Framework
+
+This package is sits within the [Common Analytical Framework (CAF)](https://transport-for-the-north.github.io/caf_homepage/intro.html),
+which is a collaboration between transport bodies in the UK to develop and maintain commonly used
+transport analytics and appraisal tools.
+
+---
+
+<details><summary><h2>Contributing</h2></summary>
+
+CAF.brain happily accepts contributions.
+
+The best way to contribute to this project is to go to the [issues tab](https://github.com/transport-for-the-north/caf.brain/issues)
+and report bugs or submit a feature request. This helps CAF.brain become more
+stable and full-featured. Please check the closed bugs before submitting a bug report to see if your
+question has already been answered.
+
+Please see our [contribution guidelines](https://github.com/Transport-for-the-North/.github/blob/main/CONTRIBUTING.rst)
+for details on contributing to the codebase or documentation.
+</details>
+
+<details><summary><h2>Documentation</h2></summary>
+
+Documentation is created using [Sphinx](https://www.sphinx-doc.org/en/master/index.html) and is hosted online at
+[cafbrain.readthedocs](https://cafbrain.readthedocs.io/en/stable/).
+
+The documentation can be built locally once all the docs requirements
+([`docs/requirements.txt`](docs/requirements.txt)) are installed into your Python environment.
+
+The provided make batch file, (inside the docs folder), allow for building the documentation in
+various target formats. The command for building the documentation is `make {target}`
+(called from within docs/), where `{target}` is the type of documentation format to build. A full
+list of all available target formats can be seen by running the `make` command without any
+arguments but the two most common are detailed below.
+
+### HTML
+
+The HTML documentation (seen on Read the Docs) can be built using the `make html` command, this
+will build the web-based documentation and provide an index.html file as the homepage,
+[`docs/build/html/index.html`](docs/build/html/index.html).
+
+### PDF
+
+The PDF documentation has some other requirements before it can be built as Sphinx will first
+build a [LaTeX](https://www.latex-project.org/) version of the documentation and then use an
+installed TeX distribution to build the PDF from those. If you already have a TeX distribution
+setup then you can build the PDF with `make latexpdf`, otherwise follow the instructions below.
+
+Installing LaTeX on Windows is best done using [MiKTeX](https://miktex.org/), as this provides a
+simple way of handling any additional TeX packages. Details of other operating systems and TeX
+distributions can be found on the [Getting LaTeX](https://www.latex-project.org/get/) page on
+LaTeX's website.
+
+MiKTeX provides an installer on its website [miktex.org/download](https://miktex.org/download),
+which will run through the process of getting it installed and setup. In addition to MiKTeX
+the specific process Sphinx uses for building PDFs is [Latexmk](https://mg.readthedocs.io/latexmk.html),
+which is a Perl script and so requires Perl to be installed on your machine, this can be done with an
+installer provided by [Strawberry Perl](https://strawberryperl.com/).
+
+Once MiKTex and Perl are installed you are able to build the PDF from the LaTeX files, Sphinx
+provides a target (latexpdf) which builds the LaTeX files then immediately builds the PDF. When
+running `make latexpdf` MiKTeX may ask for permission to installed some required TeX packages.
+Once the command has finished the PDF will be located at
+[`docs/build/latex/cafbrain.pdf`](docs/build/latex/cafbrain.pdf).
+</details>
+
+
+## Maintainers
+
+- Adil Zaheer (AdilZ16)
+- Ben Taylor (BenTaylor-TfN)
+
+## Credit
+
+This project was created using the Common Analytical Framework cookiecutter template found here:
+<https://github.com/Transport-for-the-North/cookiecutter-caf>

caf_brain-0.1.0/README.md

@@ -0,0 +1,118 @@
+![Transport for the North Logo](https://github.com/transport-for-the-north/caf.brain/blob/main/docs/TFN_Landscape_Colour_CMYK.png)
+
+<h1 align="center">CAF.brAIn</h1>
+
+<p align="center">
+<a href="https://transport-for-the-north.github.io/CAF-Handbook/python_tools/framework.html">
+  <img alt="CAF Status - Pre-Alpha" src="https://img.shields.io/badge/CAF%20Status-Pre--Alpha-orange">
+</a>
+<a href="https://pypi.org/project/caf.brain/">
+  <img alt="Supported Python versions" src="https://img.shields.io/pypi/pyversions/caf.brain.svg?style=flat-square">
+</a>
+<a href="https://pypi.org/project/caf.brain/">
+  <img alt="Latest release" src="https://img.shields.io/github/release/transport-for-the-north/caf.brain.svg?style=flat-square&maxAge=86400">
+</a>
+<a href="https://anaconda.org/conda-forge/caf.brain">
+  <img alt="Conda" src="https://img.shields.io/conda/v/conda-forge/caf.brain?style=flat-square&logo=condaforge">
+</a>
+</p>
+<p align="center">
+<a href="https://app.codecov.io/gh/transport-for-the-north/caf.brain">
+  <img alt="Coverage" src="https://img.shields.io/codecov/c/github/transport-for-the-north/caf.brain.svg?branch=main&style=flat-square&logo=CodeCov">
+</a>
+<a href="https://github.com/transport-for-the-north/caf.brain/actions?query=event%3Apush">
+  <img alt="Testing Badge" src="https://img.shields.io/github/actions/workflow/status/transport-for-the-north/caf.brain/tests.yml?style=flat-square&logo=GitHub&label=Tests">
+</a>
+<a href='https://cafbrain.readthedocs.io/en/stable/?badge=stable'>
+  <img alt='Documentation Status' src="https://img.shields.io/readthedocs/cafbrain?style=flat-square&logo=readthedocs">
+</a>
+<a href="https://github.com/psf/black">
+  <img alt="code style: black" src="https://img.shields.io/badge/code%20format-black-000000.svg">
+</a>
+</p>
+
+> [!WARNING]  
+> This package is in an early stage of development so features may change or be removed. 
+> If using this package it is recommended to set a specific version and check before 
+> upgrading to a new version.
+
+Common Analytical Framework package of Machine and Deep Learning tools.
+
+
+
+## Common Analytical Framework
+
+This package is sits within the [Common Analytical Framework (CAF)](https://transport-for-the-north.github.io/caf_homepage/intro.html),
+which is a collaboration between transport bodies in the UK to develop and maintain commonly used
+transport analytics and appraisal tools.
+
+---
+
+<details><summary><h2>Contributing</h2></summary>
+
+CAF.brain happily accepts contributions.
+
+The best way to contribute to this project is to go to the [issues tab](https://github.com/transport-for-the-north/caf.brain/issues)
+and report bugs or submit a feature request. This helps CAF.brain become more
+stable and full-featured. Please check the closed bugs before submitting a bug report to see if your
+question has already been answered.
+
+Please see our [contribution guidelines](https://github.com/Transport-for-the-North/.github/blob/main/CONTRIBUTING.rst)
+for details on contributing to the codebase or documentation.
+</details>
+
+<details><summary><h2>Documentation</h2></summary>
+
+Documentation is created using [Sphinx](https://www.sphinx-doc.org/en/master/index.html) and is hosted online at
+[cafbrain.readthedocs](https://cafbrain.readthedocs.io/en/stable/).
+
+The documentation can be built locally once all the docs requirements
+([`docs/requirements.txt`](docs/requirements.txt)) are installed into your Python environment.
+
+The provided make batch file, (inside the docs folder), allow for building the documentation in
+various target formats. The command for building the documentation is `make {target}`
+(called from within docs/), where `{target}` is the type of documentation format to build. A full
+list of all available target formats can be seen by running the `make` command without any
+arguments but the two most common are detailed below.
+
+### HTML
+
+The HTML documentation (seen on Read the Docs) can be built using the `make html` command, this
+will build the web-based documentation and provide an index.html file as the homepage,
+[`docs/build/html/index.html`](docs/build/html/index.html).
+
+### PDF
+
+The PDF documentation has some other requirements before it can be built as Sphinx will first
+build a [LaTeX](https://www.latex-project.org/) version of the documentation and then use an
+installed TeX distribution to build the PDF from those. If you already have a TeX distribution
+setup then you can build the PDF with `make latexpdf`, otherwise follow the instructions below.
+
+Installing LaTeX on Windows is best done using [MiKTeX](https://miktex.org/), as this provides a
+simple way of handling any additional TeX packages. Details of other operating systems and TeX
+distributions can be found on the [Getting LaTeX](https://www.latex-project.org/get/) page on
+LaTeX's website.
+
+MiKTeX provides an installer on its website [miktex.org/download](https://miktex.org/download),
+which will run through the process of getting it installed and setup. In addition to MiKTeX
+the specific process Sphinx uses for building PDFs is [Latexmk](https://mg.readthedocs.io/latexmk.html),
+which is a Perl script and so requires Perl to be installed on your machine, this can be done with an
+installer provided by [Strawberry Perl](https://strawberryperl.com/).
+
+Once MiKTex and Perl are installed you are able to build the PDF from the LaTeX files, Sphinx
+provides a target (latexpdf) which builds the LaTeX files then immediately builds the PDF. When
+running `make latexpdf` MiKTeX may ask for permission to installed some required TeX packages.
+Once the command has finished the PDF will be located at
+[`docs/build/latex/cafbrain.pdf`](docs/build/latex/cafbrain.pdf).
+</details>
+
+
+## Maintainers
+
+- Adil Zaheer (AdilZ16)
+- Ben Taylor (BenTaylor-TfN)
+
+## Credit
+
+This project was created using the Common Analytical Framework cookiecutter template found here:
+<https://github.com/Transport-for-the-North/cookiecutter-caf>

caf_brain-0.1.0/pyproject.toml

@@ -0,0 +1,122 @@
+[build-system]
+requires = ["setuptools>=64.0.0", "versioningit"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "caf.brain"
+dynamic = ["version", "dependencies", "optional-dependencies"]
+description = "Common Analytical Framework package of Machine and Deep Learning tools."
+readme = "README.md"
+license = { "file" = "LICENSE" }
+requires-python = ">=3.10,<3.13"
+authors = [{ name = "Transport for the North" }]
+classifiers = [
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+[project.urls]
+"Bug Tracker" = "https://github.com/transport-for-the-north/caf.brain/issues"
+Homepage = "https://github.com/transport-for-the-north/caf.brain"
+Source = "https://github.com/transport-for-the-north/caf.brain"
+Documentation = "https://cafbrain.readthedocs.io/"
+
+[tool.setuptools.dynamic]
+dependencies = { "file" = "requirements.txt" }
+
+[tool.setuptools.dynamic.optional-dependencies]
+dev = { "file" = "requirements_dev.txt" }
+vision = { "file" = "requirements_vision.txt" }
+
+# Dynamic versioning for editable installs
+[tool.setuptools.cmdclass]
+build_py = "versioningit.cmdclass.build_py"
+sdist = "versioningit.cmdclass.sdist"
+
+# Packaging options
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"caf.brain" = ["py.typed"]
+
+# Linters
+[tool.black]
+line-length = 95
+target-version = ['py310']
+
+[tool.pylint.messages_control]
+disable = [
+    "line-too-long",    # Compatibility with black
+    "too-many-lines",
+    "use-dict-literal",
+    "use-list-literal",
+]
+
+# Pylint settings
+[tool.pylint.basic]
+good-names = ["df", "fn", "ca", "tp", "x", "i"]
+
+[tool.pylint.main]
+ignore = ["__init__.py", "_version.py"]
+
+[tool.pylint.design]
+max-args = 10
+max-attributes = 15
+max-statements = 100
+
+[tool.mypy]
+packages = ["caf.brain"]
+namespace_packages = true
+ignore_missing_imports = true
+allow_redefinition = true
+
+[tool.pydocstyle]
+convention = "numpy"
+match = '(?!_test)(?!test_)(?!__init__).*\.py'
+add-ignore = [
+    "D202", # Temporary compatibility with black
+]
+
+[tool.isort]
+profile = "black"
+src_paths = ["src", "tests"]
+
+skip = ["__init__.py", "_version.py"]
+skip_glob = [".*"]
+
+# Section commenting
+import_heading_stdlib = "Built-Ins"
+import_heading_thirdparty = "Third Party"
+import_heading_firstparty = "Local Imports"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+addopts = """\
+    --cov=caf --cov-report=xml -n auto \
+    --doctest-modules --ignore=examples \
+    --junitxml=junit.xml -o junit_family=legacy\
+    """
+
+[tool.coverage.report]
+include_namespace_packages = true
+
+# Versioning
+[tool.versioningit.vcs]
+method = "git"
+match = ["v*"]
+default-tag = "0.0.1"
+
+[tool.versioningit.onbuild]
+source-file = "src/caf/brain/_version.py"
+build-file = "caf/brain/_version.py"
+
+[tool.versioningit.format]
+distance = "{base_version}+{distance}.{vcs}{rev}"
+dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
+distance-dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
+
+[project.scripts]
+caf-brain = "caf.brain.ml.__main__:model_setup"

caf_brain-0.1.0/requirements.txt

@@ -0,0 +1,12 @@
+caf.toolkit>=0.9.0
+joblib>=1.4.2
+matplotlib>=3.8.4
+mlxtend>=0.23.1
+numpy>=1.23.3
+pandas>=2.2.3
+PyYAML>=6.0.2
+scikit-learn>=1.6.1
+scipy>=1.15.1
+seaborn>=0.13.2
+statsmodels>=0.14.0
+tqdm>=4.66.2

caf_brain-0.1.0/requirements_dev.txt

@@ -0,0 +1,15 @@
+# package linters
+black>=24
+mypy>=1.10
+mypy_extensions>=1.0.0
+pydocstyle[toml]>=6.3
+pylint>=3.2
+isort>=5.13
+
+# Testing
+pytest>=8.3
+pytest-cov>=5.0
+pytest-xdist>=3.6
+
+# edit_install
+versioningit>=3.1

caf_brain-0.1.0/requirements_vision.txt

@@ -0,0 +1,12 @@
+geopandas>=1.0.1
+albumentations>=2.0.8
+beautifulsoup4>=4.12.3
+dbfread>=2.0.7
+optuna>=4.4.0
+Pillow>=11.3.0
+pyproj>=3.7.1
+rasterio>=1.4.3
+ray>=2.48.0
+tensorflow>=2.10.0
+torch>=2.8.0
+ultralytics>=8.3.175

caf_brain-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

caf_brain-0.1.0/src/caf/brain/__init__.py

@@ -0,0 +1,3 @@
+"""Common Analytical Framework package of Machine and Deep Learning tools."""
+
+from ._version import __version__

caf_brain-0.1.0/src/caf/brain/_version.py

@@ -0,0 +1,15 @@
+# Always get the current version in "editable" installs
+# `pip install -e .` / `python setup.py develop`
+def _get_version() -> str:
+    from pathlib import Path
+
+    from versioningit import get_version
+
+    return get_version(
+        project_dir=Path(__file__).parents[3],
+    )
+
+
+# The following _get_version() call will get replaced by versioningit with a
+# static version string during a build
+__version__ = "0.1.0"

caf_brain-0.1.0/src/caf/brain/ml/__init__.py

@@ -0,0 +1,16 @@
+"""
+caf.brAIn is Transport for the North's bespoke machine learning and AI
+library. It consists of a generalised end to end machine learning pipeline,
+simplified machine learning functions and a machine vision model.
+"""
+
+from caf.brain.ml._ml import (
+    tidy_data,
+    transform_data,
+    feature_selection,
+    algorithm_evaluation,
+    hparam_optim,
+    evaluate_data,
+)
+
+from caf.brain.ml._functions._ml_inputs import Models

caf_brain-0.1.0/src/caf/brain/ml/__main__.py

@@ -0,0 +1,78 @@
+"""
+Created on: 15/1/2025
+Original author: Adil Zaheer
+"""
+
+# Built-Ins
+import argparse
+import os
+from pathlib import Path
+
+# Third Party
+from caf.toolkit import LogHelper, ToolDetails
+
+# Local Imports
+from caf.brain.ml._functions._ml_inputs import PredictionModelInputs
+from caf.brain.ml._functions.prediction_model_main import main
+
+
+def _custom_load_yaml(config_path: Path) -> PredictionModelInputs:
+    """
+    Loads the YAML configuration file for the caf.brAIn full machine learning
+    pipline and returns its contents as a dictionary.
+
+    If no path is provided, defaults to 'brain.yml' which you can put in the
+    current working directory.
+
+    Parameters
+    ----------
+    config_path: Path to the YAML configuration file.
+
+    Returns
+    -------
+    Parsed contents of the YAML file as a dictionary.
+    """
+    if config_path is None:
+        config_path = Path.cwd() / "brain.yml"
+    if not config_path.exists():
+        raise FileNotFoundError(f"No config file found at {config_path}")
+
+    config_data = PredictionModelInputs.load_yaml(config_path)
+
+    return config_data
+
+
+def model_setup():
+    """
+    Function to set up logging files, output folders and input data
+    for the caf.brAIn full machine learning pipline.
+    """
+    parser = argparse.ArgumentParser(
+        description="Run caf.brAIn prediction model.",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+    parser.add_argument(
+        "--config",
+        type=Path,
+        default=Path("brain.yml"),
+        help=(
+            "Path to YAML config file. You should use docs/config.rst \n"
+            "as guidance and examples/brain.yml as a template.\n"
+        ),
+    )
+    args = parser.parse_args()
+    params = _custom_load_yaml(args.config)
+
+    output_path = params.paths.output_path / "output"
+    if not output_path.is_dir():
+        os.makedirs(output_path)
+
+    path = output_path / "log_file.log"
+    details = ToolDetails("caf.brAIn Prediction Model", "1.0.0")
+
+    with LogHelper("caf.brain", details, console=True, log_file=path):
+        main(params, output_path)
+
+
+if __name__ == "__main__":
+    model_setup()

caf_brain-0.1.0/src/caf/brain/ml/_functions/__init__.py

@@ -0,0 +1,4 @@
+"""
+Created on: 7/17/2025
+Original author: Adil Zaheer
+"""