Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (59 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

72 lines (59 loc) · 2.23 KB

Contributing to splatter-server

Thank you for your interest in contributing. We welcome issues and pull requests.

How to contribute

  • Bug reports and feature ideas: Open an issue.
  • Code changes: Open a pull request (PR) against develop. Use a branch name that matches our CI (e.g. feature/your-feature, fix/fix-description, chore/your-change).

Code standards

  • Rust: In server/rust, please run before pushing:
    • cargo fmt --all
    • cargo clippy --workspace --all-targets --all-features -- -D warnings
    • cargo test --workspace --all-features
  • CI runs the same checks on push; keep the pipeline green.

Pull request process

  1. Point your PR at the develop branch.
  2. Ensure CI passes (Rust format, clippy, tests).
  3. Keep changes focused; link related issues where applicable.

By contributing, you agree that your contributions will be licensed under the same MIT License that covers this project.

Local Development

Development setup

  • Rust (compute node): See server/rust/README.md. Copy server/rust/.env.example to server/rust/.env and configure for local DDS/DMS if needed.
  • Docker: From the repo root, docker build -t splatter-server . then run with --env-file .env.

Run Trainer

python3 run.py \
--domain_id {domain_id}
--job_id {job_id} \
--job_root_path {path/to/job/root} \
--log_level {log level}

Input Files

# Input Files
{job_root_path}
├── datasets
│   └── {dataset}
│       └── Frames.mp4
├── refined
│   └── global
│       └── refined_sfm_combined
│           ├── cameras.bin
│           ├── images.bin
│           └── points3D.bin

Output Files

# Output Files
{job_root_path}
├── Frames
│   ├── {images}
│   └── ...
├── refined
│   ├── nerfstudio-data
│   │   └── {converted nerfstudio data from colmap}
│   └── splatter
│       ├── splat.ply
│       ├── splat_rot.ply
│       ├── splat_rot.splat # this is what needs to be uploaded to dmt
│       └── splatfacto
│           └── {splat torch model}