This repository provides tools for testing and optimizing the models found in ASReview via the Optuna package. It includes a Makita template that will generate a folder infrastructure with a jobs file to run the optimizations for a specific model.
To get started, clone this repository:
git clone https://github.com/asreview/asreview-optuna.gitMake sure you have all dependencies installed:
pip install -r requirements.txtTo use the Makita template provided in this repository, download the template and follow the instructions outlined in the ASReview Makita documentation for using a custom template.
- Download the template from this repository.
- Follow the instructions here to integrate and use the template.
- Generate the folder infrastructure by pointing to the cloned template.
- Run the optimization jobs using the generated folder infrastructure.
Please note that these instructions are still a work in progress (WIP), and more detailed instructions will be added in the future.
After running the template, a file called db.sqlite3 will be generated inside the output folder. This file contains the optimization results and can be visualized using the Optuna dashboard.
To start the Optuna dashboard, run the following command:
optuna-dashboard sqlite:///output/db.sqlite3If you are running the dashboard on a server and want it to be publicly accessible, you can use the following command, making sure port 8080 is open:
optuna-dashboard sqlite:///output/db.sqlite3 --host 0.0.0.0This will allow you to access the dashboard from any device by navigating to http://<your-server-ip>:8080/.
If you have any questions or would like to contribute, please open an issue in the repository's issues section.
This project is licensed under the MIT License. See the LICENSE file for details.
The ASReview team.
This extension is part of the ASReview project (asreview.ai). It is maintained by the maintainers of ASReview LAB. See ASReview LAB for contact information and more resources.