Development Guidelines

This page serves as a comprehensive guide for developers contributing to the project. It provides information about the codebase, project structure, workflows, and best practices. Whether you’re a new contributor or a seasoned developer, this page will help you work effectively with the codebase.

Purpose

This page is intended to:

  • Explain the overall structure of the project repository.
  • Guide developers on how to set up, run, and work with the codebase.
  • Highlight current limitations and known issues.
  • Share best practices and conventions to maintain consistency.
  • Document project-specific tools, configurations, and workflows.

Content Overview

1. Project Structure

Cargo.toml (workspace)
delta/
├── Cargo.toml (
├── src/
│ ├── activations/
│ │ ├── ...
│ ├── common/
│ │ ├── ...
│ ├── dataset/
│ │ ├── image/
│ │ │ ├── ...
│ │ ├── ...
│ ├── encoders/
│ │ ├── ...
│ ├── losses/
│ │ ├── ...
│ ├── neuralnet/
│ │ ├── layers/
│ │ │ ├── ...
│ │ ├── models/
│ │ │ ├── ...
│ │ ├── ...
│ ├── optimizers/
│ │ ├── ...
│ ├── ...

2. Setting Up the Environment

3. Working with the Codebase

4. Current Limitations

5. Contributing

6. Additional Resources