SlimFace-demo / new_contruct.md
danhtran2mind's picture
Upload 164 files
b7f710c verified
|
raw
history blame
4.26 kB
slim-face-recognition/
β”œβ”€β”€ src/                     # Source code for the project
β”‚   β”œβ”€β”€ slim_face/           # Main package for your project
β”‚   β”‚   β”œβ”€β”€ __init__.py      # Marks directory as a Python package
β”‚   β”‚   β”œβ”€β”€ models/          # Model definitions and architectures
β”‚   β”‚   β”‚   β”œβ”€β”€ __init__.py
β”‚   β”‚   β”‚   β”œβ”€β”€ edgeface.py  # Model definitions (e.g., edgeface backbones)
β”‚   β”‚   β”‚   └── ...          # Other model-related scripts
β”‚   β”‚   β”œβ”€β”€ data/            # Data loading and preprocessing
β”‚   β”‚   β”‚   β”œβ”€β”€ __init__.py
β”‚   β”‚   β”‚   β”œβ”€β”€ dataset.py   # Custom Dataset classes for DataLoader
β”‚   β”‚   β”‚   β”œβ”€β”€ align.py     # Face alignment utilities (e.g., from edgeface)
β”‚   β”‚   β”‚   └── ...          # Other data-related scripts
β”‚   β”‚   β”œβ”€β”€ training/        # Training-related scripts and logic
β”‚   β”‚   β”‚   β”œβ”€β”€ __init__.py
β”‚   β”‚   β”‚   β”œβ”€β”€ train.py     # Main training script
β”‚   β”‚   β”‚   β”œβ”€β”€ accelerate_train.py  # Accelerated training script
β”‚   β”‚   β”‚   └── ...          # Other training utilities
β”‚   β”‚   β”œβ”€β”€ inference/       # Inference-related scripts and logic
β”‚   β”‚   β”‚   β”œβ”€β”€ __init__.py  # Marks directory as a Python package
β”‚   β”‚   β”‚   β”œβ”€β”€ inference.py # Face recognition inference logic
β”‚   β”‚   β”œβ”€β”€ utils/           # Utility functions (e.g., logging, metrics)
β”‚   β”‚   β”‚   β”œβ”€β”€ __init__.py
β”‚   β”‚   β”‚   β”œβ”€β”€ helpers.py   # Miscellaneous helper functions
β”‚   β”‚   β”‚   └── ...          # Other utility scripts
β”‚   β”‚   └── __main__.py      # Entry point for running the package as a module
β”œβ”€β”€ tests/                   # Unit and integration tests
β”‚   β”œβ”€β”€ __init__.py
β”‚   β”œβ”€β”€ test_data.py         # Tests for data loading
β”‚   β”œβ”€β”€ test_models.py       # Tests for model functionality
β”‚   β”œβ”€β”€ test_training.py     # Tests for training pipeline
β”‚   β”œβ”€β”€ test_inference.py    # Tests for inference pipeline
β”‚   β”œβ”€β”€ test_images/         # Sample images for testing (e.g., Elon_Musk.jpg)
β”œβ”€β”€ data/                    # Datasets and data-related files
β”‚   β”œβ”€β”€ raw/                 # Raw, unprocessed data
β”‚   β”œβ”€β”€ processed/           # Preprocessed data (e.g., aligned faces)
β”‚   └── external/            # External datasets (e.g., from Kaggle)
β”œβ”€β”€ scripts/                 # Standalone scripts for tasks like data download
β”‚   β”œβ”€β”€ download_dataset.py  # Script to download datasets (e.g., Kaggle)
β”‚   └── preprocess.py        # Data preprocessing scripts
β”œβ”€β”€ notebooks/               # Jupyter notebooks for exploration and analysis
β”‚   β”œβ”€β”€ ztest.ipynb          # Existing notebook for testing/exploration
β”‚   └── ...                  # Other exploratory notebooks
β”œβ”€β”€ ckpts/             # Model checkpoints and weights
β”‚   β”œβ”€β”€ edgeface_xs_gamma_06.pt  # Pretrained model weights
β”‚   β”œβ”€β”€ edgeface_s_gamma_05.pt   # Pretrained model weights
β”‚   └── ...                  # Other checkpoints
β”œβ”€β”€ configs/                 # Configuration files (e.g., YAML, JSON)
β”‚   β”œβ”€β”€ training.yaml        # Training hyperparameters
β”‚   └── model.yaml           # Model configurations
β”œβ”€β”€ docs/                    # Documentation files
β”‚   β”œβ”€β”€ api.md               # API documentation
β”‚   └── usage.md             # Usage instructions
β”œβ”€β”€ requirements.txt         # Main dependencies
β”œβ”€β”€ requirements_compatible.txt    # Development dependencies (e.g., testing, linting)
β”œβ”€β”€ README.md               # Project overview and setup instructions
β”œβ”€β”€ LICENSE                 # License file (e.g., MIT, Apache)
β”œβ”€β”€ .gitignore              # Git ignore file
β”œβ”€β”€ .python-version         # Python version specification (e.g., for pyenv)
β”œβ”€β”€ setup.py                # Setup script for packaging the project
└── pyproject.toml          # Modern Python project configuration (optional)