Aashish34 commited on
Commit
564e814
Β·
1 Parent(s): 745192b

add prompt enginnering

Browse files
Files changed (1) hide show
  1. README.md +157 -95
README.md CHANGED
@@ -1,133 +1,195 @@
1
  # πŸ“Š DataScience Learning Hub
2
 
3
- Welcome β€” a single repo that hosts several static, interactive learning resources for data science. Everything here is pure HTML/CSS/JS and works either by opening the `index.html` files in your browser or by serving the repo with a simple static server.
4
-
5
- ## 🎯 Live demos (GitHub Pages)
6
-
7
- Open the projects directly (after you enable GitHub Pages for the repo):
8
-
9
- - πŸ“ˆ Interactive Statistics Course β€” https://aashishgarg13.github.io/DataScience/complete-statistics/
10
- - πŸ€– Machine Learning Guide β€” https://aashishgarg13.github.io/DataScience/ml_complete-all-topics/
11
- - πŸ“Š Data Visualization β€” https://aashishgarg13.github.io/DataScience/Visualization/
12
- - πŸ”’ Mathematics for Data Science β€” https://aashishgarg13.github.io/DataScience/math-ds-complete/
13
- - βš™οΈ Feature Engineering Guide β€” https://aashishgarg13.github.io/DataScience/feature-engineering/
14
-
15
- If you want me to set up a small demo page that lists these and includes thumbnails, I can add it.
16
-
17
- ## πŸ”— Prompt engineering resources
18
-
19
- This repo focuses on data science, but many workflows now rely on well-crafted prompts. Useful prompt-engineering references:
20
-
21
- - Learn Prompting (interactive guide): https://learnprompting.org/
22
- - Prompt Engineering Guide (community-maintained): https://github.com/dair-ai/Prompt-Engineering-Guide
23
-
24
- Add one of these links to your docs or course materials where you introduce LLMs and prompts.
25
-
26
- ---
27
-
28
- ## πŸ“š What’s inside (folders)
29
-
30
- Each folder contains a standalone static site (open `index.html`). Brief overview:
31
-
32
- - `complete-statistics/` β€” Interactive Statistics Course (40+ topics, visualizations, canvas demos).
33
- - `ml_complete-all-topics/` β€” Large Mathematics / ML / Statistics learning platform (125+ topics across subjects; uses many canvas visualizations and interactive examples).
34
- - `Visualization/` β€” Data visualization examples and interactive charts.
35
- - `math-ds-complete/` β€” Mathematics for data science: linear algebra, calculus, optimization.
36
- - `feature-engineering/` β€” Feature engineering notes and interactive examples.
37
-
38
- All folders are static. No server-side code.
39
-
40
- ## πŸš€ Quick start β€” view locally
41
-
42
- Option 1 β€” open file directly:
43
-
44
- 1. In Finder or your OS file manager, double-click the folder you want and open `index.html`.
45
-
46
- Option 2 β€” run a local static server (recommended):
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
47
 
48
  ```bash
49
- # from repository root
50
  python3 -m http.server 8000
51
 
52
- # then open one of:
53
- http://localhost:8000/complete-statistics/
54
- http://localhost:8000/ml_complete-all-topics/
55
- http://localhost:8000/Visualization/
56
- http://localhost:8000/math-ds-complete/
57
- http://localhost:8000/feature-engineering/
58
  ```
59
 
60
- Tip: using a local server avoids some browser restrictions (CORS, file:// quirks) and provides consistent behaviour for the JS visualizations.
61
 
62
- ## βœ… Local file checks I ran
63
 
64
- - Verified `ml_complete-all-topics/` contains `index.html`, `style.css`, and `app.js` (these are referenced by the page).
65
- - No external CDN dependencies are required by the core sites (the pages use local CSS/JS and canvas APIs).
66
- - No image assets referenced directly inside `ml_complete-all-topics/index.html` (no missing .png/.jpg/.svg references found).
67
 
68
- If you'd like, I can add a tiny verification script (Python) that scans each `index.html` for href/src and confirms the referenced files exist.
69
 
70
- ## πŸ“ Project file layout (example)
71
 
 
 
72
  complete-statistics/
73
- β”œβ”€β”€ index.html
74
- β”œβ”€β”€ style.css
75
- └── app.js
 
76
 
 
 
77
  ml_complete-all-topics/
78
- β”œβ”€β”€ index.html
79
- β”œβ”€β”€ style.css
80
- └── app.js
 
81
 
 
 
82
  Visualization/
83
- β”œβ”€β”€ index.html
84
- β”œβ”€β”€ style.css
85
- └── app.js
 
86
 
 
 
87
  math-ds-complete/
88
- β”œβ”€β”€ index.html
89
- β”œβ”€β”€ style.css
90
- └── app.js
 
91
 
 
 
92
  feature-engineering/
93
- β”œβ”€β”€ index.html
94
- β”œβ”€β”€ style.css
95
- └── app.js
96
-
97
- ## βš™οΈ Deploying (GitHub Pages)
98
-
99
- 1. Push the `main` branch to GitHub (already done for this repo).
100
- 2. In the repository on GitHub -> Settings -> Pages, set the source to `main` branch and `/ (root)` or use `docs/` if you prefer.
101
- 3. Wait a few minutes; the site will be available at `https://<username>.github.io/<repo>/` (e.g. the links at the top of this README).
102
-
103
- Note: the sites use relative paths (`style.css`, `app.js`), so they work fine when served from a subpath such as `/DataScience/complete-statistics/`.
104
 
105
- ## 🧹 Notes about cleanup
106
 
107
- During repo cleanup I removed macOS Finder resource files (`._*`) and added a `.gitignore` entry to prevent them from being re-added. Example entries:
108
 
109
  ```
110
  ._*
111
  .DS_Store
112
- __MACOSX/
113
  ```
114
 
115
- If you see `.git.broken_<timestamp>` directories, they contain backups of previous `.git` metadata.
116
 
117
- ## πŸ™‹ Next steps (I can help)
118
 
119
- - Add screenshots/thumbnails to the README and to each project folder.
120
- - Add an automated verification script that scans all `index.html` files and confirms local assets exist. I can create a small `scripts/verify_assets.py`.
121
- - Split very long single-page projects into per-topic pages (if you want better maintainability).
122
- - Add a small 'demo index' page that lists live links and embeds screenshots.
123
 
124
- Tell me which of the above you'd like and I'll implement it.
 
 
 
 
125
 
126
- ## Contributing
 
 
 
 
127
 
128
- PRs, suggestions and fixes welcome. If you want me to add more documentation for a folder (detailed topic list, how-to-edit, or tests), say which folder and I'll add it.
 
 
 
 
129
 
130
- ## License
131
 
132
- No license file is included. If you'd like one (MIT, Apache-2.0, CC BY, etc.), tell me and I will add it.
133
 
 
 
1
  # πŸ“Š DataScience Learning Hub
2
 
3
+ Welcome to a comprehensive collection of educational web projects for learning data science! This repository contains multiple interactive courses and resources covering statistics, machine learning, visualization, mathematics, and feature engineering.
4
+
5
+ ## 🎯 Live Demos
6
+
7
+ Visit our courses directly in your browser:
8
+
9
+ - [πŸ“ˆ Interactive Statistics Course](https://aashishgarg13.github.io/DataScience/complete-statistics/)
10
+ - [πŸ€– Machine Learning Guide](https://aashishgarg13.github.io/DataScience/ml_complete-all-topics/)
11
+ - [πŸ“Š Data Visualization](https://aashishgarg13.github.io/DataScience/Visualization/)
12
+ - [πŸ”’ Mathematics for Data Science](https://aashishgarg13.github.io/DataScience/math-ds-complete/)
13
+ - [βš™οΈ Feature Engineering Guide](https://aashishgarg13.github.io/DataScience/feature-engineering/)
14
+ - [πŸ€” Prompt Engineering Guide](https://learnprompting.org/) - Interactive AI prompting course
15
+
16
+ ## πŸ”— Prompt Engineering Resources
17
+
18
+ Essential resources for mastering AI prompt engineering:
19
+
20
+ - [Learn Prompting](https://learnprompting.org/) - Comprehensive interactive guide
21
+ - [Prompt Engineering Guide](https://github.com/dair-ai/Prompt-Engineering-Guide) - Community-maintained resource
22
+ - [Anthropic's Claude Guide](https://www.anthropic.com/index/constitutional-ai-the-basics) - Advanced prompting techniques
23
+ - [OpenAI Best Practices](https://platform.openai.com/docs/guides/prompt-engineering) - Official guidelines
24
+
25
+ ## πŸ“š Contents
26
+
27
+ ### πŸ“ˆ Complete Statistics Course
28
+ - **Location:** `complete-statistics/`
29
+ - **Features:**
30
+ - 40+ Interactive Topics
31
+ - Descriptive Statistics
32
+ - Probability & Distributions
33
+ - Hypothesis Testing
34
+ - Interactive Visualizations & Canvas
35
+ - Hands-on Learning Experience
36
+
37
+ ### πŸ€– Machine Learning Guide
38
+ - **Location:** `ml_complete-all-topics/`
39
+ - **Features:**
40
+ - Comprehensive ML Topics
41
+ - Interactive Demonstrations
42
+ - Visual Learning Aids
43
+ - Step-by-Step Explanations
44
+
45
+ ### πŸ“Š Data Visualization
46
+ - **Location:** `Visualization/`
47
+ - **Features:**
48
+ - Interactive Data Visualization Examples
49
+ - Chart Types and Best Practices
50
+ - Dynamic Visualization Techniques
51
+ - Data Presentation Guidelines
52
+
53
+ ### πŸ”’ Mathematics for Data Science
54
+ - **Location:** `math-ds-complete/`
55
+ - **Features:**
56
+ - Linear Algebra Fundamentals
57
+ - Calculus for Machine Learning
58
+ - Statistical Mathematics
59
+ - Optimization Theory
60
+
61
+ ### βš™οΈ Feature Engineering Guide
62
+ - **Location:** `feature-engineering/`
63
+ - **Features:**
64
+ - Data Preprocessing Techniques
65
+ - Feature Selection Methods
66
+ - Feature Transformation
67
+ - Dimensionality Reduction
68
+
69
+ > πŸ’‘ All projects are pure static websites - no server needed! Open directly in your browser or use a simple static server.
70
+
71
+ ## πŸ”„ Auto-Update & Integration
72
+
73
+ The repository supports automatic updates for:
74
+ - New AI prompting techniques and best practices
75
+ - Interactive visualization improvements
76
+ - Additional learning resources and examples
77
+ - Community contributions and fixes
78
+
79
+ ## πŸš€ Quick Start
80
+
81
+ ### Option A: View Online
82
+ Visit our GitHub Pages hosted versions:
83
+ 1. [Statistics Course](https://aashishgarg13.github.io/DataScience/complete-statistics/)
84
+ 2. [Machine Learning Guide](https://aashishgarg13.github.io/DataScience/ml_complete-all-topics/)
85
+
86
+ ### Option B: Run Locally (Recommended for Development)
87
+
88
+ #### Simple Browser Opening:
89
+ 1. Clone this repository
90
+ 2. Navigate to either project folder
91
+ 3. Double-click `index.html`
92
+
93
+ #### Using Local Server (Recommended to avoid CORS issues):
94
+
95
+ From the repository root, run one of the following in a terminal:
96
 
97
  ```bash
98
+ # Python 3 (simple static server, available on macOS):
99
  python3 -m http.server 8000
100
 
101
+ # or using Node.js http-server (if installed):
102
+ npx http-server -c-1 . 8000
 
 
 
 
103
  ```
104
 
105
+ Then open http://localhost:8000/complete-statistics/ or http://localhost:8000/ml_complete-all-topics/ in your browser.
106
 
107
+ ## Deploy to GitHub Pages
108
 
109
+ 1. Push your changes to the `main` branch on GitHub (already done for this repo).
110
+ 2. In your repository settings on GitHub, go to "Pages" and select the `main` branch and root (`/`) as the source, or set the `gh-pages` branch if you prefer.
111
+ 3. Save β€” GitHub Pages will publish the site. For multi-site repos you can add a `docs/` folder or create separate branches, or create a small repo per site.
112
 
113
+ Because these are static sites you can also host them on Netlify, Vercel, or any static host.
114
 
115
+ ## πŸ“ Project Structure
116
 
117
+ ### Statistics Course
118
+ ```
119
  complete-statistics/
120
+ β”œβ”€β”€ index.html # Main course interface
121
+ β”œβ”€β”€ style.css # Course styling
122
+ └── app.js # Interactive visualizations
123
+ ```
124
 
125
+ ### Machine Learning Guide
126
+ ```
127
  ml_complete-all-topics/
128
+ β”œβ”€β”€ index.html # Main guide interface
129
+ β”œβ”€β”€ style.css # Guide styling
130
+ └── app.js # Interactive components
131
+ ```
132
 
133
+ ### Data Visualization
134
+ ```
135
  Visualization/
136
+ β”œβ”€β”€ index.html # Visualization examples
137
+ β”œβ”€β”€ style.css # Visualization styling
138
+ └── app.js # Interactive charts
139
+ ```
140
 
141
+ ### Mathematics for Data Science
142
+ ```
143
  math-ds-complete/
144
+ β”œβ”€β”€ index.html # Mathematics course interface
145
+ β”œβ”€β”€ style.css # Course styling
146
+ └── app.js # Interactive math demonstrations
147
+ ```
148
 
149
+ ### Feature Engineering Guide
150
+ ```
151
  feature-engineering/
152
+ β”œβ”€β”€ index.html # Feature engineering guide
153
+ β”œβ”€β”€ style.css # Guide styling
154
+ └── app.js # Interactive examples
155
+ ```
 
 
 
 
 
 
 
156
 
157
+ ## Notes about repository cleanup
158
 
159
+ While repairing the repository I removed macOS Finder metadata files (names beginning with `._`) that had been added inside the `.git` metadata and working tree. Those `._*` files are resource-fork metadata and are not project code. A `.gitignore` entry was added to ignore these moving forward:
160
 
161
  ```
162
  ._*
163
  .DS_Store
164
+ >__MACOSX/
165
  ```
166
 
167
+ If you want to inspect any backup I created of the original `.git`, look for directories named `.git.broken_<timestamp>` in the repository root β€” they contain the backed-up git metadata.
168
 
169
+ ## 🀝 Contributing
170
 
171
+ This project welcomes contributions! Here's how you can help:
 
 
 
172
 
173
+ 1. **Content Improvements**
174
+ - Add new interactive examples
175
+ - Improve existing visualizations
176
+ - Update documentation and guides
177
+ - Share prompt engineering techniques
178
 
179
+ 2. **Technical Enhancements**
180
+ - Optimize JavaScript performance
181
+ - Add responsive design features
182
+ - Improve accessibility
183
+ - Create new interactive components
184
 
185
+ 3. **Documentation**
186
+ - Add topic descriptions
187
+ - Create usage examples
188
+ - Write tutorial content
189
+ - Share prompt templates
190
 
191
+ Please check our [contribution guidelines](CONTRIBUTING.md) for detailed instructions.
192
 
193
+ ## License
194
 
195
+ Use or adapt however you like (no license file present; if you want one, tell me which license and I'll add it).