Metadata-Version: 2.1
Name: seml
Version: 0.2.1
Summary: Slurm Experiment Management Library
Home-page: http://github.com/TUM-DAML/seml
Author: DAML Group @ TUM
Author-email: zuegnerd@in.tum.de, klicpera@in.tum.de
License: UNKNOWN
Description: # `SEML`: Slurm Experiment Management Library
        **`SEML`** is the missing link between the open-source workload scheduling system `Slurm` and the experiment management tool `sacred`. It is lightweight, hackable, written in pure Python, and scales to thousands of experiments.
        
        Keeping track of computational experiments can be annoying and failure to do so can lead to lost results, duplicate running of the same experiments, and lots of headaches.
        While workload scheduling systems such as [`Slurm`](https://slurm.schedmd.com/overview.html) make it easy to run many experiments in parallel on a cluster, it can be hard to keep track of which parameter configurations are running, failed, or completed.
        [`sacred`](https://github.com/IDSIA/sacred) is a great tool to collect and manage experiments and their results, but is lacking integration with workload schedulers.
        
        **`SEML`** enables you to 
        * very easily define hyperparameter search spaces using YAML files,
        * run these hyperparameter configurations on a compute cluster using `Slurm`,
        * and to track the experimental results using `sacred` and [`MongoDB`](https://www.mongodb.com/).
        
        
        In addition, **`SEML`** offers many more features to make your life easier, such as
        * tight integration with MongoDB,
        * automatically saving and loading your source code for reproducibility,
        * providing commands for your debugger, 
        * and keeping track of resource stats.
        
        ## Get started
        To get started, install **`SEML`** using the following commands:
        ```bash
        pip install seml
        seml configure  # provide your MongoDB credentials
        ```
        ## Example
        See our simple [example](examples) to get familiar with how **`SEML`** works.
        
        ## Contact
        Contact us at zuegnerd@in.tum.de or klicpera@in.tum.de for any questions.
        
        Copyright (C) 2020  
        Daniel Zügner and Johannes Klicpera  
        Technical University of Munich
        
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
