Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
biplovbhandari committed Apr 16, 2024
1 parent a80ac16 commit d128c1e
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ on:
push:
branches:
- main
- master
pull_request:
branches:
- main
- master

jobs:
deploy:
Expand Down
4 changes: 4 additions & 0 deletions docs/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
::: aces.config
rendering:
show_root_heading: true
show_source: true
9 changes: 6 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ACES (Agricultural Classification and Estimation Service)

[![image](https://img.shields.io/pypi/v/servir-aces.svg)](https://pypi.python.org/pypi/servir-aces)

ACES (Agricultural Classification and Estimation Service) is a Python module for generating training data and training machine learning models for remote sensing applications. It provides functionalities for data processing, data loading from Earth Engine, feature extraction, and model training.

## Features
Expand All @@ -12,7 +14,7 @@ ACES (Agricultural Classification and Estimation Service) is a Python module for


## Usage
Define all your configuration in `.env` file. An example of the file is provided as `.env.example`.
Define all your configuration in `.env` file. An example of the file is provided as [`.env.example`](https://github.com/SERVIR/servir-aces/blob/main/.env.example) file.

Here's an example of how to use the ACES module:

Expand All @@ -21,7 +23,8 @@ from aces.config import Config
from aces.model_trainer import ModelTrainer

if __name__ == "__main__":
config = Config()
config_file = "config.env"
config = Config(config_file)
trainer = ModelTrainer(config)
trainer.train_model()
```
Expand All @@ -30,4 +33,4 @@ if __name__ == "__main__":
Contributions to ACES are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.

## License
This project is licensed under the GPL-3 License - see the LICENSE file for details.
This project is licensed under the [GNU General Public License v3.0](https://github.com/SERVIR/servir-aces/blob/main/LICENSE).
4 changes: 4 additions & 0 deletions docs/utils.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
::: aces.utils
rendering:
show_root_heading: true
show_source: true

0 comments on commit d128c1e

Please sign in to comment.