Skip to content

Commit

Permalink
Small README update (#638)
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxiBoether authored Dec 11, 2024
1 parent b63795f commit b04a2e1
Show file tree
Hide file tree
Showing 11 changed files with 36 additions and 14 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![codecov](https://codecov.io/github/eth-easl/modyn/graph/badge.svg?token=KFDCE03SQ4)](https://codecov.io/github/eth-easl/modyn)
[![License](https://img.shields.io/github/license/eth-easl/modyn)](https://img.shields.io/github/license/eth-easl/modyn)

Modyn is an open-source platform for model training on growing datasets, i.e., datasets where points get added over time.
Modyn is a data-centric machine learning pipeline orchestrator, i.e., a platform for model training on growing datasets where points get added over time. Check out our [blog post](https://systems.ethz.ch/research/blog/modyn.html) for a brief introduction.

</div>

Expand Down Expand Up @@ -55,9 +55,8 @@ For running all integration tests, run
Checkout our [Example Pipeline](docs/EXAMPLE.md) guide for an example on how to run a Modyn pipeline.
Checkout our [Technical Guidelines](docs/TECHNICAL.md) for some hints on developing Modyn and how to add new data selection and triggering policies.
Checkout the [Architecture Documentation](docs/ARCHITECTURE.md) for an overview of Modyn's components.
Last, checkout our [vision paper on Modyn](https://anakli.inf.ethz.ch/papers/MLonDynamicData_EuroMLSys23.pdf) for an introduction to model training on dynamic datasets.
Last, checkout our [full paper on Modyn](https://anakli.inf.ethz.ch/papers/modyn_sigmod25.pdf) for more technical background and experiments we ran using Modyn.

We are actively developing and designing Modyn, including more thorough documentation.
Please reach out via Github, Twitter, E-Mail, or any other channel of communication if you are interested in collaborating, have any questions, or have any problems running Modyn.

How to [contribute](docs/CONTRIBUTING.md).
Expand All @@ -81,3 +80,16 @@ We welcome input from both research and practice.

Modyn is being developed at the [Efficient Architectures and Systems Lab (EASL)](https://anakli.inf.ethz.ch/#Group) at the [ETH Zurich Systems Group](https://systems.ethz.ch/).
Please reach out to `mboether [at] inf [­dot] ethz [dot] ch` or open an issue on Github if you have any questions or inquiry related to Modyn and its usage.

### Paper / Citation

If you use Modyn, please cite our SIGMOD'25 paper:

```bibtex
@inproceedings{Bother2025Modyn,
author = {B\"{o}ther, Maximilian and Robroek, Ties and Gsteiger, Viktor and Ma, Xianzhe and T\"{o}z\"{u}n, P{\i}nar and Klimovic, Ana},
title = {Modyn: Data-Centric Machine Learning Pipeline Orchestration},
booktitle = {Proceedings of the Conference on Management of Data (SIGMOD)},
year = {2025},
}
```
1 change: 1 addition & 0 deletions _typos.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ extend-ignore-re = ["(?Rm)^.*# spellchecker:disable-line$"]
[default.extend-words]
strat = "strat"
fpr = "fpr"
ther = "ther"
3 changes: 2 additions & 1 deletion docker/Base/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ RUN chown -R appuser /src
USER appuser
ENV CONDA_DEFAULT_ENV modyn
ENV MAMBA_DEFAULT_ENV modyn
RUN /bin/bash -c "mamba init"
ENV MAMBA_ROOT_PREFIX /opt/mamba
RUN /bin/bash -c "mamba shell init -s bash -y"
RUN echo "mamba activate modyn" >> /home/appuser/.bashrc

# set environment variable to tell modyn that it is running in a container
Expand Down
13 changes: 9 additions & 4 deletions docker/Dependencies/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,17 @@ RUN git clone --recurse-submodules -b v1.59.2 --depth 1 --shallow-submodules htt
make -j8 && make install && cd ../../

# Install mamba
ENV CONDA_DIR /opt/mamba
ENV MAMBA_DIR /opt/mamba
RUN wget "https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh" -O ~/mamba.sh && \
ENV CONDA_DIR=/opt/mamba
ENV MAMBA_DIR=/opt/mamba
ENV MAMBA_ROOT_PREFIX /opt/mamba
RUN wget "https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh" -O ~/mamba.sh && \
/bin/bash ~/mamba.sh -b -p /opt/mamba
ENV PATH=$CONDA_DIR/bin:$PATH
RUN mamba update -n base -c defaults mamba && mamba update --all && mamba init bash
RUN mamba update -n base -c defaults mamba
RUN /bin/bash -c "mamba shell init -s bash -y"
RUN mamba update --all

# RUN /bin/bash mamba shell init

# Install dependencies
COPY ./environment.yml /tmp/environment.yml
Expand Down
2 changes: 1 addition & 1 deletion docker/Evaluator/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ FROM modynbase:latest AS evaluatorimage
RUN chmod a+x /src/modyn/evaluator/modyn-evaluator

# During debugging, this entry point will be overridden. For more information, please refer to https://aka.ms/vscode-docker-python-debug
CMD mamba run -n modyn --no-capture-output ./modyn/evaluator/modyn-evaluator ./modyn/config/examples/modyn_config.yaml
CMD mamba run -n modyn -a "" ./modyn/evaluator/modyn-evaluator ./modyn/config/examples/modyn_config.yaml
2 changes: 1 addition & 1 deletion docker/Model_Storage/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ RUN chown appuser /tmp/models
RUN chmod -R 777 /tmp/models

# During debugging, this entry point will be overridden. For more information, please refer to https://aka.ms/vscode-docker-python-debug
CMD mamba run -n modyn --no-capture-output ./modyn/model_storage/modyn-model-storage ./modyn/config/examples/modyn_config.yaml
CMD mamba run -n modyn -a "" ./modyn/model_storage/modyn-model-storage ./modyn/config/examples/modyn_config.yaml
2 changes: 1 addition & 1 deletion docker/Selector/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ RUN chown appuser /tmp/trigger_samples
RUN chmod -R 777 /tmp/trigger_samples

# During debugging, this entry point will be overridden. For more information, please refer to https://aka.ms/vscode-docker-python-debug
CMD mamba run -n modyn --no-capture-output ./modyn/selector/modyn-selector ./modyn/config/examples/modyn_config.yaml
CMD mamba run -n modyn -a "" ./modyn/selector/modyn-selector ./modyn/config/examples/modyn_config.yaml
2 changes: 1 addition & 1 deletion docker/Supervisor/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ RUN chown appuser /tmp/evaluation_results
RUN chmod -R 777 /tmp/evaluation_results

# During debugging, this entry point will be overridden. For more information, please refer to https://aka.ms/vscode-docker-python-debug
CMD mamba run -n modyn --no-capture-output ./modyn/supervisor/modyn-supervisor ./modyn/config/examples/modyn_config.yaml
CMD mamba run -n modyn -a "" ./modyn/supervisor/modyn-supervisor ./modyn/config/examples/modyn_config.yaml
2 changes: 1 addition & 1 deletion docker/Tests/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ USER appuser
RUN chmod a+x /src/integrationtests/run.sh

# During debugging, this entry point will be overridden. For more information, please refer to https://aka.ms/vscode-docker-python-debug
CMD mamba run -n modyn --no-capture-output /src/integrationtests/run.sh
CMD mamba run -n modyn -a "" /src/integrationtests/run.sh
2 changes: 1 addition & 1 deletion docker/Trainer_Server/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ RUN mkdir -p /tmp/offline_dataset
RUN chown appuser /tmp/offline_dataset

# During debugging, this entry point will be overridden. For more information, please refer to https://aka.ms/vscode-docker-python-debug
CMD mamba run -n modyn --no-capture-output ./modyn/trainer_server/modyn-trainer-server ./modyn/config/examples/modyn_config.yaml
CMD mamba run -n modyn -a "" ./modyn/trainer_server/modyn-trainer-server ./modyn/config/examples/modyn_config.yaml
3 changes: 3 additions & 0 deletions modyn/config/schema/pipeline/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,6 @@ def validate_bts_training_selection_works(self) -> Self:
)

return self


ModynPipelineConfig.model_rebuild()

0 comments on commit b04a2e1

Please sign in to comment.