Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tjkessler committed Aug 1, 2023
1 parent ddcd22e commit f30195e
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 1 deletion.
10 changes: 10 additions & 0 deletions docs/api_blends.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,26 @@
# ecnet.blends

## ecnet.blends.cetane_number

::: ecnet.blends.cetane_number
handler: python

## ecnet.blends.yield_sooting_index

::: ecnet.blends.yield_sooting_index
handler: python

## ecnet.blends.kinematic_viscosity

::: ecnet.blends.kinematic_viscosity
handler: python

## ecnet.blends.cloud_point

::: ecnet.blends.cloud_point
handler: python

## ecnet.blends.lower_heating_value

::: ecnet.blends.lower_heating_value
handler: python
8 changes: 8 additions & 0 deletions docs/api_callbacks.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# ecnet.callbacks

## ecnet.callbacks.CallbackOperator

::: ecnet.callbacks.CallbackOperator
handler: python

## ecnet.callbacks.Callback

::: ecnet.callbacks.Callback
handler: python

## ecnet.callbacks.LRDecayLinear

::: ecnet.callbacks.LRDecayLinear
handler: python

## ecnet.callbacks.Validator

::: ecnet.callbacks.Validator
handler: python
26 changes: 26 additions & 0 deletions docs/api_datasets.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,66 @@
# ecnet.datasets

## ecnet.datasets.QSPRDataset

::: ecnet.datasets.QSPRDataset
handler: python

## ecnet.datasets.QSPRDatasetFromFile

::: ecnet.datasets.QSPRDatasetFromFile
handler: python

## ecnet.datasets.QSPRDatasetFromValues

::: ecnet.datasets.QSPRDatasetFromValues
handler: python

## ecnet.datasets.load_bp

::: ecnet.datasets.load_bp
handler: python

## ecnet.datasets.load_cn

::: ecnet.datasets.load_cn
handler: python

## ecnet.datasets.load_cp

::: ecnet.datasets.load_cp
handler: python

## ecnet.datasets.load_kv

::: ecnet.datasets.load_kv
handler: python

## ecnet.datasets.load_lhv

::: ecnet.datasets.load_lhv
handler: python

## ecnet.datasets.load_mon

::: ecnet.datasets.load_mon
handler: python

## ecnet.datasets.load_pp

::: ecnet.datasets.load_pp
handler: python

## ecnet.datasets.load_ron

::: ecnet.datasets.load_ron
handler: python

## ecnet.datasets.load_ysi

::: ecnet.datasets.load_ysi
handler: python

## ecnet.datasets.load_mp

::: ecnet.datasets.load_mp
handler: python
8 changes: 8 additions & 0 deletions docs/api_tasks.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# ecnet.tasks

## ecnet.tasks.select_rfr

::: ecnet.tasks.select_rfr
handler: python

## ecnet.tasks.tune_batch_size

::: ecnet.tasks.tune_batch_size
handler: python

## ecnet.tasks.tune_model_architecture

::: ecnet.tasks.tune_model_architecture
handler: python

## ecnet.tasks.tune_training_parameters

::: ecnet.tasks.tune_training_parameters
handler: python
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ Additional dependencies (torch, sklearn, padelpy, alvadescpy, ecabc) will be ins

git clone https://github.com/ecrl/ecnet
cd ecnet
python setup.py install
pip install .

0 comments on commit f30195e

Please sign in to comment.