forecat

Keras based Forescast model builder

https://github.com/alquimodelia/forecat

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.8%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Keras based Forescast model builder

Basic Info
  • Host: GitHub
  • Owner: alquimodelia
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Size: 215 KB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 3
  • Releases: 3
Created over 2 years ago · Last pushed about 2 years ago
Metadata Files
Readme Contributing License Code of conduct Citation Security

README.md

Forecat

Forecat is a Python package that provides a Keras-based forecast model builder.

Python Keras

It provides the arquitectures for CNN, LSTM, and Encoder Decoder, and even from imagery UNET. Any suggestions and tips are welcome. Use this to fastly have your forecast models ready to use!

Usage

To use Forecat, follow these steps:

bash pip install forecat

Since Forecat is based on keras-core you can choose which backend to use, otherwise it will default to tensorflow. To change backend change the KERAS-BACKEND enviromental variable. Follow this.

To get an arquiteture you only need to have a simple configuration and call the module:

```python import forecat

The input arguments

inputargs = { "Xtimeseries": 168, "Ytimeseries": 24, "nfeaturestrain": 18, "nfeatures_predict": 1, }

This is make a model with shapes:

# input_shape = (N, 168, 18)
# output_shape = (N, 24, 1)

forearch = forecat.CNNArch(**input_args)

Now for Vanilla and Stacked CNN:

architectureargs = {} VanillaCNN = forearch.architecture(**architectureargs)

architectureargs = {"blockrepetition": 2} StackedCNN = forearch.architecture(**architecture_args)

Keras Models ready to use:

VanillaCNN.summary() StackedCNN.summary()

```

Contribution

Contributions to Forecat are welcome! If you find any issues or have suggestions for improvement, please feel free to contribute. Make sure to update tests as appropriate and follow the contribution guidelines.

License

Forecat is licensed under the MIT License, which allows you to use, modify, and distribute the package according to the terms of the license. For more details, please refer to the LICENSE file.

Owner

  • Name: alquimodelia
  • Login: alquimodelia
  • Kind: organization

Citation (CITATION.cff)

cff-version: 0.0.3
message: "If you use this software, please cite it as below."
authors:
- family-names: "Santos"
  given-names: "João"
  orcid: "https://orcid.org/0009-0007-5995-8060"
title: "Alquimodelia: Forecat"
version: 0.0.3
date-released: 2023-10-09
url: "https://github.com/alquimodelia/forecat"
repository-code: "https://github.com/alquimodelia/forecat"
keywords:
  - python
  - machine learning
  - forecast
  - model builder
type: software
license: BSD-3-Clause
license-url: "https://github.com/alquimodelia/forecat/blob/main/LICENSE"

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 3
  • Total pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: about 21 hours
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • JotaFan (2)
Pull Request Authors
  • JotaFan (3)
Top Labels
Issue Labels
enhancement (2) help wanted (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 32 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
  • Total maintainers: 1
pypi.org: forecat

Keras based Forescast model builder

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 32 Last month
Rankings
Dependent packages count: 7.3%
Average: 37.9%
Dependent repos count: 68.5%
Maintainers (1)
Last synced: 7 months ago

Dependencies

.github/workflows/build_pages.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4.6.0 composite
  • dorny/paths-filter v2 composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/pr_validation.yml actions
  • actions/checkout v3.5.2 composite
  • actions/setup-python v4.6.0 composite
  • dorny/paths-filter v2 composite
.github/workflows/publish.yml actions
  • JRubics/poetry-publish v1.17 composite
  • actions/checkout v3.5.2 composite
poetry.lock pypi
  • 113 dependencies
pyproject.toml pypi
  • black * develop
  • isort * develop
  • poetry * develop
  • ruff * develop
  • sphinx * docs
  • jax *
  • keras >=3
  • numpy *
  • pandas *
  • python ^3.9
  • pytorch *
  • tensorflow *
  • pytest * tests