dev-jas commited on
Commit
cbc0b57
Β·
unverified Β·
1 Parent(s): 8a41ab5

Update README.md

Browse files

(docs): Add Strategic Expansion Objectives section and improve README formatting

- Added a detailed "Strategic Expansion Objectives" section outlining future development plans.
- Fixed minor typos in the README.
- Included a Git diagram visualizing repository dependencies and relationships for better clarity.

Files changed (1) hide show
  1. README.md +6 -9
README.md CHANGED
@@ -30,8 +30,8 @@ A research project developed as part of AIRE 2025. This system applies deep lear
30
  ## πŸ“ Project Structure (Cleaned and Current)
31
 
32
  ```text
33
- polymer_project/
34
- β”œβ”€β”€ datasets/rdwp # Raman spectra
35
  β”œβ”€β”€ models/ # Model architectures
36
  β”œβ”€β”€ scripts/ # Training, inference, utilities
37
  β”œβ”€β”€ outputs/ # Artifacts: models, logs, plots
@@ -39,6 +39,9 @@ polymer_project/
39
  └── environment.yml # (local) Conda execution environment
40
  ```
41
 
 
 
 
42
  ---
43
 
44
  ## βœ… Current Status
@@ -70,13 +73,6 @@ polymer_project/
70
 
71
  ---
72
 
73
- ## πŸ”€ Branching Strategy
74
-
75
- | Branch | Purpose|
76
- |--------|--------|
77
- | `main` | Local development (CPU) |
78
- | `hpc_main` | Cluster-ready (HPC; GPU) |
79
-
80
  **Environments:**
81
 
82
  ```bash
@@ -210,3 +206,4 @@ These files are intentionally excluded from version control via `.gitignore`
210
  - **Additive modularity**: Models, images, and FTIR added as clean, distinct layers rather than overwriting core functionality
211
  - **Transparency & reproducibility**: All expansions documented, tested, and logged with clear outputs.
212
  - **Future-oriented design**: Workflows structured to support ongoing collaboration and successor-safe research.
 
 
30
  ## πŸ“ Project Structure (Cleaned and Current)
31
 
32
  ```text
33
+ ml-polymer-recycling/
34
+ β”œβ”€β”€ datasets/
35
  β”œβ”€β”€ models/ # Model architectures
36
  β”œβ”€β”€ scripts/ # Training, inference, utilities
37
  β”œβ”€β”€ outputs/ # Artifacts: models, logs, plots
 
39
  └── environment.yml # (local) Conda execution environment
40
  ```
41
 
42
+ <img width="1773" height="848" alt="ml-polymer-gitdiagram-0" src="https://github.com/user-attachments/assets/bb5d93dc-7ab9-4259-8513-fb680ae59d64" />
43
+
44
+
45
  ---
46
 
47
  ## βœ… Current Status
 
73
 
74
  ---
75
 
 
 
 
 
 
 
 
76
  **Environments:**
77
 
78
  ```bash
 
206
  - **Additive modularity**: Models, images, and FTIR added as clean, distinct layers rather than overwriting core functionality
207
  - **Transparency & reproducibility**: All expansions documented, tested, and logged with clear outputs.
208
  - **Future-oriented design**: Workflows structured to support ongoing collaboration and successor-safe research.
209
+