Skip to content

Commit 324cd96

Browse files
committed
add short example of a config file
1 parent cb85ab8 commit 324cd96

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

docs/hipster.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,26 @@
1-
# Generate HiPS and catalog
1+
# HiPSter: Generate HiPS and catalog
2+
3+
The following command generates a HiPS representation and a catalog showing the real images located
4+
on the latent space using the trained model.
25

3-
The following command generates a HiPS representation and a catalog showing the real images located on the latent space using the trained model.
46

57
```bash
68
hipster --checkpoint <checkpoint-file>.ckpt
79
```
810

911
Call `hipster --help` for more information.
1012

13+
Example of a HiPSter config file:
14+
```yaml
15+
root_path: HiPSter
16+
html:
17+
url: http://localhost:8083
18+
title: HiPSter representation of Gaia XP DR3
19+
aladin_lite_version: latest
20+
tasks:
21+
<list of tasks>
22+
```
23+
1124
For visualization, a Python HTTP server can be started by executing `python3 -m http.server 8082` within the HiPSter output file.
1225

1326

0 commit comments

Comments
 (0)