Skip to content

Commit 2b19a95

Browse files
Merge pull request #581 from ChrisRackauckas-Claude/docs-improvements-20260107-120242
Documentation improvements: Fix grammar and clarity issues
2 parents 3a41f63 + a1167ce commit 2b19a95

5 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/src/basis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Basis
66

77
## API
88

9-
Next to [ModelingToolkits API](https://docs.sciml.ai/ModelingToolkit/stable/basics/AbstractSystem/) for `AbstractSystems`, a [`Basis`](@ref) can be called with the following methods:
9+
Next to [ModelingToolkit's API](https://docs.sciml.ai/ModelingToolkit/stable/basics/AbstractSystem/) for `AbstractSystems`, a [`Basis`](@ref) can be called with the following methods:
1010

1111
```@docs
1212
dynamics

docs/src/citations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ If you are using `DataDrivenDiffEq.jl` for research, please cite
44

55
```bibtex
66
@software{datadrivendiffeq,
7-
author = {JuliusMartensen and
7+
author = {Julius Martensen and
88
Christopher Rackauckas and others},
99
title = {DataDrivenDiffEq.jl},
1010
month = jul,

docs/src/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,10 @@ Pkg.add("DataDrivenSR")
9999

100100
- See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions.
101101
- There are a few community forums:
102-
102+
103103
+ The #diffeq-bridged and #sciml-bridged channels in the
104-
[Julia Slack](https://julialang.org/slack/),
105-
you can message @AlCap23 to start a discussion.
104+
[Julia Slack](https://julialang.org/slack/).
105+
You can message @AlCap23 to start a discussion.
106106
+ The #diffeq-bridged and #sciml-bridged channels in the
107107
[Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
108108
+ On the [Julia Discourse forums](https://discourse.julialang.org)

docs/src/libs/datadrivensparse/sparse_regression.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ can be solved using an [`ImplicitOptimizer`](@ref). Similar to the formulation a
4343
Where the matrix of evaluated basis elements $\varPhi_y \in \mathbb R^{\lvert \varphi \rvert} \times \mathbb R^{m}$ now may also contain basis functions which are dependent on the target variables $y \in \mathbb R^{n_y}$.
4444

4545
!!! warning "Tuning parameters for sparse regression"
46-
47-
The algorithms used by `DataDrivenSparse` are sensible to the tuning of the hyperparameters! These are problem and coefficient specific, e.g. depend on the data and the unknown equations. While the examples used here are designed to work well, the used settings are not guaranteed to lead to success on other problems. User who want to explore the space of possible hyperparameters further might be interested in using [Hyperopt.jl](https://github.com/baggepinnen/Hyperopt.jl).
46+
47+
The algorithms used by `DataDrivenSparse` are sensitive to the tuning of the hyperparameters! These are problem and coefficient specific, e.g., depend on the data and the unknown equations. While the examples used here are designed to work well, the used settings are not guaranteed to lead to success on other problems. Users who want to explore the space of possible hyperparameters further might be interested in using [Hyperopt.jl](https://github.com/baggepinnen/Hyperopt.jl).
4848

4949
## [Algorithms](@id sparse_algorithms)
5050

docs/src/solvers/common.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ Common choices for `selector` are `rss`, `bic`, `aic`, `aicc`, and `r2`. Given t
5959
options = DataDrivenCommonOptions(selector = (x) -> rss(x) / nobs(x))
6060
```
6161

62-
Which results in the mean squared error of the system.
62+
which results in the mean squared error of the system.

0 commit comments

Comments
 (0)