chore: initialize ml_for_robotics repository
This commit is contained in:
25
.gitignore
vendored
Normal file
25
.gitignore
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
.venv/
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*.so
|
||||
.pytest_cache/
|
||||
.mypy_cache/
|
||||
.ruff_cache/
|
||||
.ipynb_checkpoints/
|
||||
.DS_Store
|
||||
.idea/
|
||||
.vscode/
|
||||
build/
|
||||
dist/
|
||||
*.egg-info/
|
||||
wandb/
|
||||
runs/
|
||||
checkpoints/
|
||||
artifacts/
|
||||
outputs/
|
||||
data/
|
||||
*.pt
|
||||
*.pth
|
||||
*.ckpt
|
||||
*.onnx
|
||||
*.log
|
||||
31
README.md
Normal file
31
README.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# ml_for_robotics
|
||||
|
||||
Arbeitsbereich für eigene Notizen, Experimente, Material und kleine Artefakte rund um ML für Robotik.
|
||||
|
||||
## Ziel
|
||||
|
||||
Dieses Projekt sammelt:
|
||||
|
||||
- Vorlesungsnotizen
|
||||
- eigene Recherche
|
||||
- Experimente und Prototypen
|
||||
- referenzierbares Material für spätere Ausarbeitung
|
||||
|
||||
## Status
|
||||
|
||||
Noch keine feste Struktur. Wir bauen sie schrittweise auf, sobald klar ist, welche Themen und Artefakte hier rein sollen.
|
||||
|
||||
## Schnellstart fuer Vast.ai SSH
|
||||
|
||||
Das Repository ist absichtlich minimal gehalten, damit es sich in einer SSH-basierten GPU-Session schnell aktivieren laesst.
|
||||
|
||||
1. Repository klonen oder in den Zielordner kopieren.
|
||||
2. `./scripts/bootstrap.sh` ausfuehren.
|
||||
3. Mit `. .venv/bin/activate` die virtuelle Umgebung aktivieren.
|
||||
4. Eigene Abhaengigkeiten in `requirements.txt` oder spaeter in `pyproject.toml` ergaenzen.
|
||||
|
||||
## Layout
|
||||
|
||||
- `src/ml_for_robotics/` fuer Python-Code
|
||||
- `scripts/` fuer Setup-Hilfen
|
||||
- `requirements.txt` fuer optionale Laufzeit-Abhaengigkeiten
|
||||
16
pyproject.toml
Normal file
16
pyproject.toml
Normal file
@@ -0,0 +1,16 @@
|
||||
[build-system]
|
||||
requires = ["setuptools>=68", "wheel"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "ml_for_robotics"
|
||||
version = "0.1.0"
|
||||
description = "Workspace for ML for robotics experiments"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.10"
|
||||
|
||||
[tool.setuptools]
|
||||
package-dir = {"" = "src"}
|
||||
|
||||
[tool.setuptools.packages.find]
|
||||
where = ["src"]
|
||||
1
requirements.txt
Normal file
1
requirements.txt
Normal file
@@ -0,0 +1 @@
|
||||
# Add runtime dependencies here when the project starts using them.
|
||||
7
scripts/bootstrap.sh
Executable file
7
scripts/bootstrap.sh
Executable file
@@ -0,0 +1,7 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
python3 -m venv .venv
|
||||
. .venv/bin/activate
|
||||
python -m pip install --upgrade pip setuptools wheel
|
||||
python -m pip install -e .
|
||||
5
src/ml_for_robotics/__init__.py
Normal file
5
src/ml_for_robotics/__init__.py
Normal file
@@ -0,0 +1,5 @@
|
||||
"""ml_for_robotics package."""
|
||||
|
||||
__all__ = ["__version__"]
|
||||
|
||||
__version__ = "0.1.0"
|
||||
Reference in New Issue
Block a user