Mercurial > repos > goeckslab > ludwig_experiment

annotate README.md @ 5:78b1e3921576 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
author goeckslab
date Sat, 21 Jun 2025 15:05:21 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
1 # Galaxy-Ludwig
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
2 A library of Galaxy deep learning tools based on Ludwig.
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
3
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
4 # Install Galaxy-Ludwig into Galaxy
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
5 We assume that you have Galaxy running and docker installed in your server/laptop.
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
6 * Create a new folder named ludwig(or whatever) under Galaxy’s tools folder.
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
7 * Select and download the branch you want to install and use. Copy all XML, py files under the tools folder in this repo to the ludwig folder(the folder you created in the last step).
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
8 * Update `tool_conf.xml` to include Galaxy-Ludwig. See [documentation](https://docs.galaxyproject.org/en/master/admin/tool_panel.html) for more details. This is an example:
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
9 ```
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
10 <section id="ludwig" name="Ludwig Applications">
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
11 <tool file="ludwig/ludwig_evaluate.xml" />
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
12 <tool file="ludwig/ludwig_experiment.xml" />
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
13 <tool file="ludwig/ludwig_hyperopt.xml" />
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
14 <tool file="ludwig/ludwig_predict.xml" />
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
15 <tool file="ludwig/ludwig_render_config.xml" />
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
16 <tool file="ludwig/ludwig_train.xml" />
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
17 <tool file="ludwig/ludwig_visualize.xml" />
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
18 </section>
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
19 ```
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
20
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
21
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
22 * This is an example of a `job_conf.yml` file that you can create to enable Docker for a local Galaxy instance where you want Ludwig-related jobs to run:
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
23
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
24 ```
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
25 runners:
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
26 local:
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
27 load: galaxy.jobs.runners.local:LocalJobRunner
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
28 workers: 4
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
29 execution:
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
30 default: local
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
31 environments:
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
32 local:
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
33 runner: local
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
34 docker_enabled: true
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
35 ```
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
36 If you are using an older version of Galaxy, then `job_conf.xml` would be something you want to configure instead of `job_conf.yml`. Then you would want to configure destination instead of execution and environment.
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
37 See [documentation](https://docs.galaxyproject.org/en/master/admin/jobs.html#running-jobs-in-containers) for job_conf configuration.
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
38 * If you haven’t set `sanitize_all_html: false` in `galaxy.yml`, please set it to False to enable our HTML report functionality.
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
39
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
40 # Get Galaxy-Ludwig docker image
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
41
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
42 This step is optional.
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
43 If you want to speed up your runs, execute the following command:
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
44 ```
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
45 docker pull quay.io/goeckslab/galaxy-ludwig-gpu:0.10.1
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
46 ```
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
47
78b1e3921576 planemo upload for repository https://github.com/goeckslab/Galaxy-Ludwig.git commit 4dc221b2fa9717552787f0985ad3fc3df4460158
goeckslab
parents:
diff changeset
48 * Should be good to go.