Spaces:
Runtime error
Runtime error
Commit
·
4f5b471
1
Parent(s):
e237787
delete noise folder
Browse files
docs/.ipynb_checkpoints/mkdocs-checkpoint.yml
CHANGED
@@ -1,10 +1,15 @@
|
|
1 |
-
site_name: TEMPS
|
2 |
-
|
3 |
theme:
|
4 |
-
name:
|
5 |
-
|
6 |
-
plugins:
|
7 |
-
- mkdocstrings
|
8 |
|
9 |
-
|
|
|
10 |
- Home: index.md
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
site_name: TEMPS Documentation
|
|
|
2 |
theme:
|
3 |
+
name: material
|
|
|
|
|
|
|
4 |
|
5 |
+
# Define the navigation structure for the docs
|
6 |
+
nav:
|
7 |
- Home: index.md
|
8 |
+
|
9 |
+
# Define the URL where the site will be deployed
|
10 |
+
site_url: https://github.com/lauracabayol/TEMPS
|
11 |
+
|
12 |
+
markdown_extensions:
|
13 |
+
- codehilite
|
14 |
+
- toc
|
15 |
+
- admonition
|
docs/docs/.ipynb_checkpoints/index-checkpoint.md
DELETED
@@ -1,72 +0,0 @@
|
|
1 |
-
# TEMPS documentation!
|
2 |
-
Welcome to the documentation for TEMPS!
|
3 |
-
This repository contains a neural network to predict photometric redshifts. The neural network incorporates domain adaptation, a methodology to mitigate the impact of sample bias in the spectroscopic training samples.
|
4 |
-
|
5 |
-
The training and validation data are not available in the repository, but the model can be trained with new data. The model is also deployed and available [here](https://huggingface.co/spaces/lauracabayol/TEMPS). The model in production enables making predictions for new galaxies with the pretrained models.
|
6 |
-
|
7 |
-
Details on the data and the pa
|
8 |
-
|
9 |
-
|
10 |
-
## Table of Contents
|
11 |
-
|
12 |
-
- [Prerequisites](##Prerequisites)
|
13 |
-
- [Installation](##installation)
|
14 |
-
- [Usage](##usage)
|
15 |
-
- [Deployed model](##Accessing-the-LSTM-depolyed-model)
|
16 |
-
- [License](##license)
|
17 |
-
|
18 |
-
## Prerequisites
|
19 |
-
|
20 |
-
Before proceeding, ensure that the following software is installed on your system:
|
21 |
-
|
22 |
-
- Python 3.10
|
23 |
-
- [pip](https://pip.pypa.io/en/stable/installation/)
|
24 |
-
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
|
25 |
-
|
26 |
-
You will also need to clone the repository to your local environment by executing the following commands:
|
27 |
-
|
28 |
-
```bash
|
29 |
-
git clone https://github.com/lauracabayol/TEMPS
|
30 |
-
cd TEMPS
|
31 |
-
```
|
32 |
-
## Installation
|
33 |
-
|
34 |
-
We recommend using a conda environment with Python 3.10 by executing the following commands:
|
35 |
-
```
|
36 |
-
conda create -n temps -c conda-forge python=3.10
|
37 |
-
conda activate temps
|
38 |
-
```
|
39 |
-
Once your environment is ready, proceed with the installation of the package:
|
40 |
-
|
41 |
-
```
|
42 |
-
pip install -e .
|
43 |
-
```
|
44 |
-
This will already install the dependencies.
|
45 |
-
|
46 |
-
|
47 |
-
## Deployed model
|
48 |
-
Alternatively, one can access the deployed models at [HuggigFace](https://huggingface.co/spaces/lauracabayol/TEMPS). This enbles making predictions from a file with photometric measurements. The format should be a csv file with the following band photometries in this order: G,R,I,Z,Y,H,J.
|
49 |
-
|
50 |
-
|
51 |
-
## Notebooks
|
52 |
-
The repository contains notebooks to reproduce the figures in the [Paper](paper)
|
53 |
-
The notebooks are loaded on GitHub as .py files. To convert them to .ipynb use <jupytext>
|
54 |
-
|
55 |
-
```bash
|
56 |
-
jupytext --to ipynb notebooks/*.py
|
57 |
-
```
|
58 |
-
|
59 |
-
## Training the Model
|
60 |
-
The model can be trained using the train.py script at the repo main directory.
|
61 |
-
|
62 |
-
```
|
63 |
-
python train.py --config-file data/config.yml
|
64 |
-
```
|
65 |
-
One only needs to modify the config file to point at the input files. Make sure to also specify the photometric bands naming, and the spectroscopic and photometric redshift columns.
|
66 |
-
Input catalogs must be in .fits or .csv formats and these should already contain clean photometry.
|
67 |
-
|
68 |
-
If extinction_corr is set to True, one must specify the column namings of the E_VB corrections in the config file.
|
69 |
-
|
70 |
-
## License
|
71 |
-
|
72 |
-
This project is licensed under the MIT License. You are free to use, modify, and distribute this project as long as you adhere to the license terms.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|