https://github.com/cisco-open/modelsmith
A toolkit for optimizing machine learning models for practical applications
https://github.com/cisco-open/modelsmith
Last synced: about 2 months ago
JSON representation
A toolkit for optimizing machine learning models for practical applications
- Host: GitHub
- URL: https://github.com/cisco-open/modelsmith
- Owner: cisco-open
- License: apache-2.0
- Created: 2024-04-24T01:09:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-05T06:57:52.000Z (2 months ago)
- Last Synced: 2025-03-05T07:30:26.615Z (2 months ago)
- Language: Python
- Homepage:
- Size: 86.2 MB
- Stars: 26
- Watchers: 3
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
ModelSmith serves as a toolkit for compressing machine learning models, designed to enhance their speed, reduce their size, and improve energy efficiency. This toolbox addresses the demands for smaller model sizes, minimal memory usage, quicker inference times, energy-saving operations, and scenarios conforming to bandwidth limitations.
ModelSmith makes it ideal for deploying on a diverse array of devices and platforms, ensuring satisfactory performance. Its main features encompass post-training quantization, machine unlearning and a range of pruning algorithms, essential for optimizing models.
ModelSmith is developed by researchers and engineers working at Cisco Research.
## Table of Contents
- [Getting Started](#getting-started)
- [FAQ](#faq)
- [Features](#features)
- [Supported features](#supported-technologies)
- [Contributions](#contributions)
- [License](#license)
## Getting Started
To get started with ModelSmith, follow these steps:
1. Clone the repository to your local machine:
```shell
git clone https://github.com/cisco-open/modelsmith.git
```
## FAQ
### 1. How do I configure ModelSmith to run locally?
- **Manual Configuration**: [Read here](docs/configure-the-project-locally.md).
- **Docker Configuration**: [Read here](docs/configure-modelsmith-on-local-machine-docker.md).
### 2. How do I configure ModelSmith to run on VM?
- **Manual Configuration**: [Read here](docs/configure-modelsmith-on-vm.md).
- **Docker Configuration**: [Read here](docs/configure-modelsmith-on-vm-docker.md).
## Features
- **Frontend Server**: ModelSmith's frontend is built using Angular and is deployed as a production build to the 'frontend/server/modelsmith-build' folder. The frontend server, powered by Express.js, serves the web application in to users in optimized mode on port 4200. It provides a user interface for interacting with the application.
- **Backend Server**: ModelSmith includes a backend server built using Node.js, which serves as the core of the application. The backend server handles various tasks such as model optimization, deployment, and management. It is accessible on port 3000. The backend offers APIs and services to support the frontend's functionality and communicates with a VM for running the python scripts.
- **ModelSmith Project - Python Files for Model Training**: This feature includes a comprehensive collection of Python scripts designed for the training of machine learning models. These scripts are fine-tuned for high efficiency and can be executed on local machines with GPU support or on virtual machines (VMs), offering flexibility for users to train models using their own hardware or cloud resources.
## Supported technologies
- [Post Training Quantization](machine_learning_core/examples_quant)
- [Model Pruning](machine_learning_core/examples_pruning)
- [Machine Unlearning](machine_learning_core/examples_unlearning)
- [AutoAWQ](machine_learning_core/autoawq/)
- [Multiflow](machine_learning_core/multiflow)
## Contributions
ModelSmith strives to maintain a more up-to-date fork and encourages contributions from all individuals.
## Maintainers and contributors
Yuguang Yao
Ioan Pop (John)
Yuzhang Shang
Yihua Zhang
Gaowen Liu
## Contributing & Future Directions
> We have several TODO's spread out throughout our files! We will continue working in these directions to improve ModelSmith, adjusting as needed based on our user's feedback
We intend to add functionalities to the log analysis for unsupervised log analysis.
If you wish to contribute or suggest any additional funtionalities, please check out [Contributing Guidelines](/CONTRIBUTING.md)
## License
[Apache License 2.0](LICENSE).