Skip to content

Commit

Permalink
fix data loading for testing. Update doc links for better pattern
Browse files Browse the repository at this point in the history
  • Loading branch information
wilsonrljr committed Feb 22, 2025
1 parent d6c7dda commit 7f33b38
Show file tree
Hide file tree
Showing 71 changed files with 346 additions and 302 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,4 @@ pip-wheel-metadata
catboost_info/
sysidentpy.code-workspace
examples/data/
raw.githubusercontent.com/
19 changes: 19 additions & 0 deletions docs/community-support/community-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
template: overrides/main.html
title: Contribute
---

<div class="feature-grid">
<div class="feature-card">
<a href="https://sysidentpy.org/community-support/get-help/" class="feature-link">
<h3>💬 Get Help</h3>
</a>
<p>Need assistance? Explore various options for getting help, including discussion forums, GitHub issues, and community support channels.</p>
</div>
<div class="feature-card">
<a href="https://sysidentpy.org/community-support/meetups/ai-networks-meetup/" class="feature-link">
<h3>🤝 Meetups</h3>
</a>
<p>Connect with other SysIdentPy users through meetups, online events, and community discussions. Stay updated on upcoming gatherings and share your experience.</p>
</div>
</div>
File renamed without changes.
8 changes: 0 additions & 8 deletions docs/community_support/meetups/meetup.md

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Welcome to SysIdentPy's documentation! Learn how to get started with SysIdentPy
This book provides in-depth guidance to support your work with <strong>SysIdentPy</strong>.
</p>
<p>
🛠️ You can also explore the <a href="https://sysidentpy.org/user_guide/overview/" target="_blank"><strong>tutorials in the documentation</strong></a> for practical, hands-on examples.
🛠️ You can also explore the <a href="https://sysidentpy.org/user-guide/overview/" target="_blank"><strong>tutorials in the documentation</strong></a> for practical, hands-on examples.
</p>
</div>
</div>
Expand Down Expand Up @@ -103,49 +103,49 @@ the help box. Install with:

<div class="feature-grid">
<div class="feature-card">
<a href="https://sysidentpy.org/getting_started/quickstart-guide/#model-classes" class="feature-link">
<a href="https://sysidentpy.org/getting-started/quickstart-guide/#model-classes" class="feature-link">
<h3>🧩 NARMAX Philosophy</h3>
</a>
<p>Build variations like <strong>NARX</strong>, <strong>NAR</strong>, <strong>ARMA</strong>, <strong>NFIR</strong>, and more.</p>
</div>
<div class="feature-card">
<a href="https://sysidentpy.org/getting_started/quickstart-guide/#model-structure-selection-algorithms" class="feature-link">
<a href="https://sysidentpy.org/getting-started/quickstart-guide/#model-structure-selection-algorithms" class="feature-link">
<h3>📝 Model Structure Selection</h3>
</a>
<p>Use methods like <strong>FROLS</strong>, <strong>MetaMSS</strong>, and combinations with parameter estimation techniques.</p>
</div>
<div class="feature-card">
<a href="https://sysidentpy.org/user_guide/tutorials/basis-function-overview/" class="feature-link">
<a href="https://sysidentpy.org/user-guide/tutorials/basis-function-overview/" class="feature-link">
<h3>🔗 Basis Function</h3>
</a>
<p>Choose from <strong>8+ basis functions</strong>, combining linear and nonlinear types for custom NARMAX models.</p>
</div>
<div class="feature-card">
<a href="https://sysidentpy.org/user_guide/tutorials/parameter-estimation-overview/" class="feature-link">
<a href="https://sysidentpy.org/user-guide/tutorials/parameter-estimation-overview/" class="feature-link">
<h3>🎯 Parameter Estimation</h3>
</a>
<p>Over <strong>15 parameter estimation methods</strong> for exploring various structure selection scenarios.</p>
</div>
<div class="feature-card">
<a href="https://sysidentpy.org/user_guide/tutorials/multiobjective-parameter-estimation-overview/" class="feature-link">
<a href="https://sysidentpy.org/user-guide/tutorials/multiobjective-parameter-estimation-overview/" class="feature-link">
<h3>⚖️ Multiobjective Estimation</h3>
</a>
<p>Minimize different objective functions using <strong>affine information</strong> for parameter estimation.</p>
</div>
<div class="feature-card">
<a href="https://sysidentpy.org/user_guide/how_to/simulating-existing-models/" class="feature-link">
<a href="https://sysidentpy.org/user-guide/how_to/simulating-existing-models/" class="feature-link">
<h3>🔄 Model Simulation</h3>
</a>
<p>Reproduce paper results easily with <strong>SimulateNARMAX</strong>. Test and compare published models effortlessly.</p>
</div>
<div class="feature-card">
<a href="https://sysidentpy.org/user_guide/how_to/create-a-narx-neural-network/" class="feature-link">
<a href="https://sysidentpy.org/user-guide/how_to/create-a-narx-neural-network/" class="feature-link">
<h3>🤖 Neural NARX (PyTorch)</h3>
</a>
<p>Integrate with <strong>PyTorch</strong> for custom neural NARX architectures using all PyTorch optimizers and loss functions.</p>
</div>
<div class="feature-card">
<a href="https://sysidentpy.org/user_guide/tutorials/general-NARX-models/" class="feature-link">
<a href="https://sysidentpy.org/user-guide/tutorials/general-NARX-models/" class="feature-link">
<h3>🛠️ General Estimators</h3>
</a>
<p>Compatible with <strong>scikit-learn</strong>, <strong>Catboost</strong>, and more for creating NARMAX models.</p>
Expand All @@ -158,22 +158,22 @@ the help box. Install with:

<ul class="custom-link-list">
<li>
<a href="https://sysidentpy.org/developer_guide/contribute/" target="_blank">🤝 Contribute to SysIdentPy</a>
<a href="https://sysidentpy.org/developer-guide/contribute/" target="_blank">🤝 Contribute to SysIdentPy</a>
</li>
<li>
<a href="https://sysidentpy.org/getting_started/license/" target="_blank">📜 License Information</a>
<a href="https://sysidentpy.org/getting-started/license/" target="_blank">📜 License Information</a>
</li>
<li>
<a href="https://sysidentpy.org/community_support/get-help/" target="_blank">🆘 Get Help & Support</a>
<a href="https://sysidentpy.org/community-support/get-help/" target="_blank">🆘 Get Help & Support</a>
</li>
<li>
<a href="https://sysidentpy.org/community_support/meetups/ai-networks-meetup/" target="_blank">📅 Meetups</a>
<a href="https://sysidentpy.org/community-support/meetups/ai-networks-meetup/" target="_blank">📅 Meetups</a>
</li>
<li>
<a href="https://sysidentpy.org/landing-page/sponsor/" target="_blank">💖 Become a Sponsor</a>
</li>
<li>
<a href="https://sysidentpy.org/user_guide/API/narmax-base/" target="_blank">🧩 Explore NARMAX Base Code</a>
<a href="https://sysidentpy.org/user-guide/API/narmax-base/" target="_blank">🧩 Explore NARMAX Base Code</a>
</li>
</ul>

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ As you can see, SysIdentPy supports numerous model combinations, each tailored t
This book provides in-depth guidance to support your work with <strong>SysIdentPy</strong>.
</p>
<p>
🛠️ You can also explore the <a href="https://sysidentpy.org/user_guide/overview/" target="_blank"><strong>tutorials in the documentation</strong></a> for practical, hands-on examples.
🛠️ You can also explore the <a href="https://sysidentpy.org/user-guide/overview/" target="_blank"><strong>tutorials in the documentation</strong></a> for practical, hands-on examples.
</p>
</div>
</div>
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
120 changes: 60 additions & 60 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -149,62 +149,62 @@ markdown_extensions:
nav:
- Home: index.md
- Getting started:
- Overview: getting_started/getting-started.md
- Quickstart Guide: getting_started/quickstart-guide.md
- Introduction to NARMAX: getting_started/narmax-intro.md
- License: getting_started/license.md
- Overview: getting-started/getting-started.md
- Quickstart Guide: getting-started/quickstart-guide.md
- Introduction to NARMAX: getting-started/narmax-intro.md
- License: getting-started/license.md
- User guide:
- Overview: user_guide/overview.md
- Overview: user-guide/overview.md
- Tutorials:
- Features:
- your-first-model: user_guide/tutorials/your-first-model.ipynb
- model-with-multiple-inputs: user_guide/tutorials/model-with-multiple-inputs.ipynb
- parameter-estimation-overview: user_guide/tutorials/parameter-estimation-overview.ipynb
- basis-function-overview: user_guide/tutorials/basis-function-overview.ipynb
- information-criteria-overview: user_guide/tutorials/information-criteria-overview.ipynb
- general-NARX-models: user_guide/tutorials/general-NARX-models.ipynb
- fourier-NARX-overview: user_guide/tutorials/fourier-NARX-overview.ipynb
- aols-overview: user_guide/tutorials/aols-overview.ipynb
- nfir-model-overview: user_guide/tutorials/NFIR-model-overview.ipynb
- importance-of-extended-least-squares: user_guide/tutorials/importance-of-extended-least-squares.ipynb
- your-first-model: user-guide/tutorials/your-first-model.ipynb
- model-with-multiple-inputs: user-guide/tutorials/model-with-multiple-inputs.ipynb
- parameter-estimation-overview: user-guide/tutorials/parameter-estimation-overview.ipynb
- basis-function-overview: user-guide/tutorials/basis-function-overview.ipynb
- information-criteria-overview: user-guide/tutorials/information-criteria-overview.ipynb
- general-NARX-models: user-guide/tutorials/general-NARX-models.ipynb
- fourier-NARX-overview: user-guide/tutorials/fourier-NARX-overview.ipynb
- aols-overview: user-guide/tutorials/aols-overview.ipynb
- nfir-model-overview: user-guide/tutorials/NFIR-model-overview.ipynb
- importance-of-extended-least-squares: user-guide/tutorials/importance-of-extended-least-squares.ipynb
- Electrical and Mechanical Systems:
- modeling-a-magneto-rheological-damper-device: user_guide/tutorials/modeling-a-magneto-rheological-damper-device.ipynb
- silver-box-system: user_guide/tutorials/silver-box-system.ipynb
- coupled-eletric-device: user_guide/tutorials/coupled-eletric-device.ipynb
- wiener-hammerstein-system: user_guide/tutorials/wiener-hammerstein-system.ipynb
- f16-aircraft: user_guide/tutorials/f-16-aircraft.ipynb
- f-16-aircraft-n-steps-ahead-prediction: user_guide/tutorials/f-16-aircraft-n-steps-ahead-prediction.ipynb
- electromechanical-system-identification-overview: user_guide/tutorials/electromechanical-system-identification-overview.ipynb
- electromechanical-system-identification-metamss: user_guide/tutorials/electromechanical-system-identification-metamss.ipynb
- electromechanical-system-identification-entropic-regression: user_guide/tutorials/electromechanical-system-identification-entropic-regression.ipynb
- multiobjective-parameter-estimation-overview: user_guide/tutorials/multiobjective-parameter-estimation-overview.ipynb
- modeling-a-magneto-rheological-damper-device: user-guide/tutorials/modeling-a-magneto-rheological-damper-device.ipynb
- silver-box-system: user-guide/tutorials/silver-box-system.ipynb
- coupled-eletric-device: user-guide/tutorials/coupled-eletric-device.ipynb
- wiener-hammerstein-system: user-guide/tutorials/wiener-hammerstein-system.ipynb
- f16-aircraft: user-guide/tutorials/f-16-aircraft.ipynb
- f-16-aircraft-n-steps-ahead-prediction: user-guide/tutorials/f-16-aircraft-n-steps-ahead-prediction.ipynb
- electromechanical-system-identification-overview: user-guide/tutorials/electromechanical-system-identification-overview.ipynb
- electromechanical-system-identification-metamss: user-guide/tutorials/electromechanical-system-identification-metamss.ipynb
- electromechanical-system-identification-entropic-regression: user-guide/tutorials/electromechanical-system-identification-entropic-regression.ipynb
- multiobjective-parameter-estimation-overview: user-guide/tutorials/multiobjective-parameter-estimation-overview.ipynb
- Industrial and Corporate:
- m4-benchmark: user_guide/tutorials/m4-benchmark.ipynb
- air-passenger-benchmark: user_guide/tutorials/air-passenger-benchmark.ipynb
- load-forecasting-benchmark: user_guide/tutorials/load-forecasting-benchmark.ipynb
- pv-forecasting-benchmark: user_guide/tutorials/PV-forecasting-benchmark.ipynb
- m4-benchmark: user-guide/tutorials/m4-benchmark.ipynb
- air-passenger-benchmark: user-guide/tutorials/air-passenger-benchmark.ipynb
- load-forecasting-benchmark: user-guide/tutorials/load-forecasting-benchmark.ipynb
- pv-forecasting-benchmark: user-guide/tutorials/PV-forecasting-benchmark.ipynb
- How to:
- create-a-narx-neural-network: user_guide/how_to/create-a-narx-neural-network.ipynb
- save-and-load-models: user_guide/how_to/save-and-load-models.ipynb
- set-specific-lags: user_guide/how_to/set-specific-lags.ipynb
- simulating-existing-models: user_guide/how_to/simulating-existing-models.ipynb
- use-extended-least-squares: user_guide/how_to/use-extended-least-squares.ipynb
- create-a-narx-neural-network: user-guide/how-to/create-a-narx-neural-network.ipynb
- save-and-load-models: user-guide/how-to/save-and-load-models.ipynb
- set-specific-lags: user-guide/how-to/set-specific-lags.ipynb
- simulating-existing-models: user-guide/how-to/simulating-existing-models.ipynb
- use-extended-least-squares: user-guide/how-to/use-extended-least-squares.ipynb
- API:
- NARMAX Base: user_guide/API/narmax-base.md
- Basis Functions: user_guide/API/basis-function.md
- FROLS: user_guide/API/frols.md
- MetaMSS: user_guide/API/metamss.md
- AOLS: user_guide/API/aols.md
- Entropic Regression: user_guide/API/entropic-regression.md
- Neural NARX: user_guide/API/neural-narx.md
- General Estimators: user_guide/API/general-estimators.md
- Parameter Estimation: user_guide/API/parameter-estimation.md
- Multiobjective Parameter Estimation: user_guide/API/multiobjective-parameter-estimation.md
- Simulation: user_guide/API/simulation.md
- Residual Analysis: user_guide/API/residues.md
- Metaheuristics: user_guide/API/metaheuristics.md
- Metrics: user_guide/API/metrics.md
- Utils: user_guide/API/utils.md
- NARMAX Base: user-guide/API/narmax-base.md
- Basis Functions: user-guide/API/basis-function.md
- FROLS: user-guide/API/frols.md
- MetaMSS: user-guide/API/metamss.md
- AOLS: user-guide/API/aols.md
- Entropic Regression: user-guide/API/entropic-regression.md
- Neural NARX: user-guide/API/neural-narx.md
- General Estimators: user-guide/API/general-estimators.md
- Parameter Estimation: user-guide/API/parameter-estimation.md
- Multiobjective Parameter Estimation: user-guide/API/multiobjective-parameter-estimation.md
- Simulation: user-guide/API/simulation.md
- Residual Analysis: user-guide/API/residues.md
- Metaheuristics: user-guide/API/metaheuristics.md
- Metrics: user-guide/API/metrics.md
- Utils: user-guide/API/utils.md
- Companion Book:
- Preface: book/0-Preface.md
- Contents: book/0.1-Contents.md
Expand All @@ -219,20 +219,20 @@ nav:
- 9. Validation: book/9-Validation.md
- 10. Case Studies: book/10-Case-Studies.md
- Developer guide:
- How to contribute: developer_guide/contribute.md
- How to contribute: developer-guide/contribute.md
- Documentation:
- Documentation Overview: developer_guide/documentation-overview.md
- How To Write a Tutorial: developer_guide/how-to-write-a-tutorial.md
- How To Write a How-to Guide: developer_guide/how-to-write-a-how-to-guide.md
- Documentation Overview: developer-guide/documentation-overview.md
- How To Write a Tutorial: developer-guide/how-to-write-a-tutorial.md
- How To Write a How-to Guide: developer-guide/how-to-write-a-how-to-guide.md
- Community & Support:
- Get Help: community_support/get-help.md
- Meetups: community_support/meetups/meetup.md
- community-overview: community-support/community-overview.md
- Get Help: community-support/get-help.md
- Meetups:
- AI Networks Meetup: community_support/meetups/ai-networks-meetup.md
- Nubank Timeseries Meetup: community_support/meetups/nubank-meetup.md
- Nubank Open Source Talk: community_support/meetups/nubank-meetup-open-source.md
- GCoM Meetup: community_support/meetups/gcom-meetup.md
- Estatidados Meetup: community_support/meetups/estatidados.md
- AI Networks Meetup: community-support/meetups/ai-networks-meetup.md
- Nubank Timeseries Meetup: community-support/meetups/nubank-meetup.md
- Nubank Open Source Talk: community-support/meetups/nubank-meetup-open-source.md
- GCoM Meetup: community-support/meetups/gcom-meetup.md
- Estatidados Meetup: community-support/meetups/estatidados.md
- About: landing-page/about-us.md
- Changelog: changelog/changelog.md
- Sponsors: landing-page/sponsor.md
4 changes: 3 additions & 1 deletion sysidentpy/general_estimators/tests/test_general_narx.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ def create_test_data(n=1000):
# y = np.reshape(y, (len(y), 1))
# x = np.reshape(x, (len(x), 1))
# data = np.concatenate([x, y], axis=1)
data = np.loadtxt("examples/datasets/data_for_testing.txt")
data = np.loadtxt(
"https://raw.githubusercontent.com/wilsonrljr/sysidentpy-data/refs/heads/main/datasets/testing/data_for_testing.txt"
)
x = data[:, 0].reshape(-1, 1)
y = data[:, 1].reshape(-1, 1)
return x, y, theta
Expand Down
4 changes: 3 additions & 1 deletion sysidentpy/model_structure_selection/tests/test_aols.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ def create_test_data(n=1000):
# y = np.reshape(y, (len(y), 1))
# x = np.reshape(x, (len(x), 1))
# data = np.concatenate([x, y], axis=1)
data = np.loadtxt("examples/datasets/data_for_testing.txt")
data = np.loadtxt(
"https://raw.githubusercontent.com/wilsonrljr/sysidentpy-data/refs/heads/main/datasets/testing/data_for_testing.txt"
)
x = data[:, 0].reshape(-1, 1)
y = data[:, 1].reshape(-1, 1)
return x, y, theta
Expand Down
4 changes: 3 additions & 1 deletion sysidentpy/model_structure_selection/tests/test_er.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ def create_test_data(n=1000):
# y = np.reshape(y, (len(y), 1))
# x = np.reshape(x, (len(x), 1))
# data = np.concatenate([x, y], axis=1)
data = np.loadtxt("examples/datasets/data_for_testing.txt")
data = np.loadtxt(
"https://raw.githubusercontent.com/wilsonrljr/sysidentpy-data/refs/heads/main/datasets/testing/data_for_testing.txt"
)
x = data[:, 0].reshape(-1, 1)
y = data[:, 1].reshape(-1, 1)
return x, y, theta
Expand Down
4 changes: 3 additions & 1 deletion sysidentpy/model_structure_selection/tests/test_frols.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ def create_test_data(n=1000):
# y = np.reshape(y, (len(y), 1))
# x = np.reshape(x, (len(x), 1))
# data = np.concatenate([x, y], axis=1)
data = np.loadtxt("examples/datasets/data_for_testing.txt")
data = np.loadtxt(
"https://raw.githubusercontent.com/wilsonrljr/sysidentpy-data/refs/heads/main/datasets/testing/data_for_testing.txt"
)
x = data[:, 0].reshape(-1, 1)
y = data[:, 1].reshape(-1, 1)
return x, y, theta
Expand Down
4 changes: 3 additions & 1 deletion sysidentpy/model_structure_selection/tests/test_metamss.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@

def create_test_data(n=1000):
theta = np.array([[0.6], [-0.5], [0.7], [-0.7], [0.2]])
data = np.loadtxt("examples/datasets/data_for_testing.txt")
data = np.loadtxt(
"https://raw.githubusercontent.com/wilsonrljr/sysidentpy-data/refs/heads/main/datasets/testing/data_for_testing.txt"
)
x = data[:, 0].reshape(-1, 1)
y = data[:, 1].reshape(-1, 1)
return x, y, theta
Expand Down
Loading

0 comments on commit 7f33b38

Please sign in to comment.