tahamajs/SP / README.md
tahamajs's picture
|
download
raw
3.27 kB

SP Repository (Organized Workspace)

This repository contains one core stochastic-processes project plus multiple course and research material collections.
The main assignment project is in project-sp-2023/; everything else is organized as supporting content.

What Is Inside

Path Purpose Approx size Files
project-sp-2023/ Main SP 2023 project (notebook + datasets + handout) 10M 7
courses/ Course websites, homework sets, and solved notebooks 138M 411
materials/ Research/assignment material bank and code templates 45M 1357
archives/ Original zip/pdf archives and extracted copies 70M 324
docs/ Repository organization and structure index <1M 1

Detailed structure index: docs/PROJECT_STRUCTURE.md.

Canonical Directory Map

sp/
├── README.md
├── report.tex
├── project-sp-2023/
│   ├── data/
│   │   ├── hafez.txt
│   │   └── sequences/{train.json,test.json}
│   ├── docs/Project_SP_2023.pdf
│   └── notebooks/text_generation.ipynb
├── courses/
│   ├── StochasticProcessesCourse/
│   ├── SP-Homeworks/
│   └── 18.445-spring-2015/
├── docs/
│   └── PROJECT_STRUCTURE.md
├── materials/
│   ├── assignments-hard/
│   ├── src/
│   ├── notebooks/
│   ├── slides/
│   ├── stochastic_refs/
│   └── external/
└── archives/
    ├── *.zip/*.pdf
    └── extracted/

Main Project (project-sp-2023)

The primary SP 2023 assignment is fully contained in project-sp-2023/.

  • Notebook: project-sp-2023/notebooks/text_generation.ipynb
  • Text corpus: project-sp-2023/data/hafez.txt
  • Sequence datasets: project-sp-2023/data/sequences/train.json, project-sp-2023/data/sequences/test.json
  • Prompt PDF: project-sp-2023/docs/Project_SP_2023.pdf

Folder-specific guide: project-sp-2023/README.md.

Quick Start

cd /Users/tahamajs/Documents/uni/sp
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install numpy notebook
jupyter notebook project-sp-2023/notebooks/text_generation.ipynb

Organization Rules

  • Keep new SP 2023 task code/data inside project-sp-2023/.
  • Keep downloaded third-party repositories only in materials/external/.
  • Keep frozen originals in archives/; keep derived/extracted copies in archives/extracted/.
  • Keep reusable Python modules in materials/src/.
  • Do not place new datasets or notebooks at the repository root.

Folder Guides

  • docs/PROJECT_STRUCTURE.md — full project inventory and file organization notes.
  • archives/README.md — archive file catalog.
  • materials/README.md — materials folder map and assignment-bank conventions.
  • courses/StochasticProcessesCourse/README.md — curated course implementation notes.

Notes

  • report.tex at root is kept as a legacy draft file and is not part of the project-sp-2023 submission folder.
  • This repository includes nested source snapshots (e.g., under materials/external/ and courses/SP-Homeworks/), so treat it as a monorepo-style workspace rather than a single Python package.

Xet Storage Details

Size:
3.27 kB
·
Xet hash:
4bf8dfe855b61d4fe58cbe295799dbb43613d89c9c731a077d16698a1b16c042

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