Metadata-Version: 2.4
Name: lume-model
Version: 3.0.0
Summary: DEPRECATED: This package has been renamed to lume-torch
Author: SLAC National Accelerator Laboratory
License: Copyright (c) 2017-2020, The Board of Trustees of the Leland Stanford
        Junior University, through SLAC National Accelerator Laboratory
        (subject to receipt of any required approvals from the U.S. Dept. of
        Energy). All rights reserved. Redistribution and use in source and
        binary forms, with or without modification, are permitted provided
        that the following conditions are met:
        
        (1) Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.
        
        (2) Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.
        
        (3) Neither the name of the Leland Stanford Junior University, SLAC
        National Accelerator Laboratory, U.S. Dept. of Energy nor the names of
        its contributors may be used to endorse or promote products derived
        from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
        "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
        LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
        A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
        OWNER, THE UNITED STATES GOVERNMENT, OR CONTRIBUTORS BE LIABLE FOR ANY
        DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
        GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
        IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
        OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
        ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
        You are under no obligation whatsoever to provide any bug fixes,
        patches, or upgrades to the features, functionality or performance of
        the source code ("Enhancements") to anyone; however, if you choose to
        make your Enhancements available either publicly, or directly to SLAC
        National Accelerator Laboratory, without imposing a separate written
        license agreement for such Enhancements, then you hereby grant the
        following license: a non-exclusive, royalty-free perpetual license to
        install, use, modify, prepare derivative works, incorporate into other
        computer software, distribute, and sublicense such Enhancements or
        derivative works thereof, in binary and source code form.
        
Project-URL: Homepage, https://github.com/slaclab/lume-model
Project-URL: Documentation, https://slaclab.github.io/lume-model/
Project-URL: Bug Tracker, https://github.com/slaclab/lume-model/issues
Keywords: machine learning,accelerator physics
Classifier: Development Status :: 7 - Inactive
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: lume-torch[mlflow]>=3.0.0
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocstrings; extra == "docs"
Requires-Dist: mkdocstrings-python; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocs-include-markdown-plugin; extra == "docs"
Dynamic: license-file

# LUME-model (DEPRECATED)

> ⚠️ **`lume-model` has been renamed to [`lume-torch`](https://github.com/lume-science/lume-torch).**
>
> `lume-model` is deprecated as of version **3.0.0** and will not receive
> further updates. Version 3.0.0 is a thin compatibility shim that simply
> re-exports `lume-torch`. Please migrate to `lume-torch`.

## Migration

1. Install the new package:

   ```bash
   pip install lume-torch
   ```

   `mlflow` support is now an optional extra:

   ```bash
   pip install "lume-torch[mlflow]"
   ```

2. Update your imports from `lume_model` to `lume_torch`:

   ```python
   # Before
   from lume_model.models.torch_model import TorchModel
   from lume_model.variables import ScalarVariable

   # After
   from lume_torch.models.torch_model import TorchModel
   from lume_torch.variables import TorchScalarVariable
   ```

## Links

- New package: https://github.com/lume-science/lume-torch
- Documentation: https://lume-science.github.io/lume-torch/
- Issue tracker: https://github.com/lume-science/lume-torch/issues
