Development: Finalise Folder Structure

[ufukygmr]

What?

Closes #35

This PR initializes the AtlasML Python project by setting up its foundational structure, including FastAPI routing, an ML module, and standalone script execution for machine learning.

Why?

This setup ensures that:

The ML module (ml) can be run independently for development.
The FastAPI-based microservice structure is modular and scalable.
Environment variables can be easily configured via os.getenv().
Documentation is updated with instructions for both standalone and API-based usage.

How?

Key Changes:

• Updated app.py:

  • Introduced ENV = os.getenv("ENV", "dev") for environment-based configurations.
  • Included the FastAPI router from atlasml.routers.health_router.
  • Removed the hardcoded /health endpoint, moving it to a separate module.

• Created ml/ module:

  • ml_runner.py: A standalone script to execute the ML model independently.
  • model.py: Contains a mock ML handler function (ml_model_handler()) for model execution.
  • init.py: Makes the module importable.

• Refactored API Routing:

  • routers/health.py: Moved the /health endpoint here.
  • routers/init.py: Imports health_router for modularity.
  • Updated app.py to include health_router.

• Updated Documentation (README.md):

  • Added instructions for running the ML module independently:
    bash
    Copy
    Edit
    python atlasml/ml/ml_runner.py
    Maintained API instructions for running with FastAPI and Uvicorn.

Affected Issues & Feature Proposal

Checklist

General

• I chose a title conforming to the naming conventions for pull requests.

AtlasML - Machine Learning

• I updated the machine learning documentation.

Testing

Testing Instructions

Requirements:

• At least 3 Competencies with no Relations
• ...

Steps:

1. ...
2. ...

Review Progress

Code Review

• Code Review 1
• Code Review 2

Manuel Test

• Test 1
• Test 2

[ardakaraman0]

LGTM 🚀

[github-actions]

There hasn't been any activity on this pull request recently. Therefore, this pull request has been automatically marked as stale and will be closed if no further activity occurs within seven days. Thank you for your contributions.