Skip to content

Commit d98aaf9

Browse files
Update README.md
1 parent 6ab00d1 commit d98aaf9

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,43 @@ Support open source software by participating in [Hacktoberfest](https://hacktob
1111
> Please check all issues labelled as `hacktoberfest` to start contributing!
1212
1313
Kindly consider leaving a :star: if you like the repository and our organisation.
14+
## Project Goals
15+
16+
### **Purpose**
17+
18+
- Provide clear, well-documented building blocks for ML (data handling, simple models, utilities) implemented primarily in **Go**, with optional Python access points.
19+
20+
### **Scope**
21+
22+
- Small, focused algorithms and demos you can run **locally**.
23+
- Friendly for first-time contributors: readable code, bite-sized issues, and a straightforward workflow.
24+
25+
### **Target Audience**
26+
27+
- Students & self-learners who want to understand “how it works under the hood.”
28+
- Hacktoberfest / open-source contributors who prefer approachable issues.
29+
- Practitioners curious about Go in ML pipelines.
30+
31+
## Key Features & Overview
32+
33+
- **Go-first implementations**
34+
The project’s core is in Go (currently ~93% Go). This keeps binaries fast and the code explicit/learnable.
35+
[View on GitHub → IEEE-VIT/pykitzoid](https://github.com/IEEE-VIT/pykitzoid.git)
36+
37+
- **Python wrapper (work-in-progress)**
38+
A thin Python interface (see `pyproject.toml`) is scaffolded so users can experiment from notebooks while the logic stays in Go.
39+
[View pyproject.toml](https://github.com/IEEE-VIT/pykitzoid/blob/main/pyproject.toml)
40+
41+
- **Self-contained demos**
42+
The `demo/` directory includes runnable examples that show how to use the library end-to-end. (Add more demos as algorithms land.)
43+
[View demo folder](https://github.com/IEEE-VIT/pykitzoid/tree/main/demo)
44+
45+
- **Contributor-friendly defaults**
46+
- A `Makefile` with handy targets (build/test/format) for a smooth DX.
47+
[View Makefile](https://github.com/IEEE-VIT/pykitzoid/blob/main/Makefile)
48+
- Clear [CONTRIBUTING guidelines](https://github.com/IEEE-VIT/pykitzoid/blob/main/CONTRIBUTING.md).
49+
- MIT-licensed. [View License](https://github.com/IEEE-VIT/pykitzoid/blob/main/LICENSE)
50+
1451

1552
## Getting Started
1653

0 commit comments

Comments
 (0)