tahamajs/SP / docs /PROJECT_STRUCTURE.md
tahamajs's picture
|
download
raw
2.88 kB
# Project Structure Index
This file documents the organized file layout of `/Users/tahamajs/Documents/uni/sp`.
## Top-Level Files
- `README.md` - main repository guide.
- `report.tex` - legacy standalone LaTeX draft file.
- `.gitignore` - local ignore rules.
## Top-Level Directories
| Directory | Purpose | Files | Dirs |
| --- | --- | ---: | ---: |
| `project-sp-2023/` | Core SP 2023 assignment project | 7 | 5 |
| `courses/` | Course websites, homeworks, and notebooks | 411 | 100 |
| `materials/` | Research assignment bank, templates, references, external repos | 1357 | 567 |
| `archives/` | Original archives and extracted copies | 324 | 60 |
| `docs/` | Structure and organization documentation | 1 | 1 |
## `project-sp-2023/` (Core Assignment)
- `project-sp-2023/notebooks/text_generation.ipynb`
- `project-sp-2023/data/hafez.txt`
- `project-sp-2023/data/sequences/train.json`
- `project-sp-2023/data/sequences/test.json`
- `project-sp-2023/docs/Project_SP_2023.pdf`
- `project-sp-2023/README.md`
See also: `project-sp-2023/README.md`.
## `courses/`
| Path | Purpose | Files |
| --- | --- | ---: |
| `courses/StochasticProcessesCourse/` | Curated assignments + implementations | 32 |
| `courses/SP-Homeworks/` | Full SP homeworks collection snapshot | 191 |
| `courses/18.445-spring-2015/` | MIT 18.445 static course mirror | 187 |
## `materials/`
| Path | Purpose | Files |
| --- | --- | ---: |
| `materials/assignments-hard/` | Large assignment bank (`01_...` to `150_...`) | 1094 |
| `materials/src/` | Reusable Python module templates | 17 |
| `materials/notebooks/` | Notebook templates/demos | 3 |
| `materials/slides/` | SP slides (copied/organized) | 11 |
| `materials/stochastic_refs/` | PDF references + notes | 4 |
| `materials/external/` | Third-party cloned repositories and related papers | 221 |
### `materials/assignments-hard/` Layout Convention
- 150 numbered assignment folders are present (`01_...` through `150_...`).
- Typical files per assignment:
- `README.md` (present in all 150)
- `report.tex` (present in 109)
- `notebooks/demo.ipynb` (present in 114)
- `src/` module folder (present in 124)
## `archives/`
- Root archive files:
- `archives/Project_SP_2023.zip`
- `archives/PHW1_SP_2023.zip`
- `archives/PHW2_SP_2023.pdf`
- `archives/18.445-spring-2015.zip`
- Extracted content:
- `archives/extracted/Project_SP_2023/`
- `archives/extracted/PHW1_SP_2023/`
- `archives/extracted/18.445-spring-2015/`
See also: `archives/README.md`.
## Organization Policy
- Add new SP 2023 assignment files under `project-sp-2023/`.
- Add new archival downloads under `archives/` and extract into `archives/extracted/`.
- Keep third-party code in `materials/external/` only.
- Keep reusable local scripts/modules in `materials/src/`.
- Keep root clean: no new notebooks, datasets, or generated binaries at repository root.

Xet Storage Details

Size:
2.88 kB
·
Xet hash:
99c30cb7a5bdf5d78c52e80ea498688ba765396058bf5a91bd394a275be976d6

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.