Skip to content

Remove unnecessary doc bits after unification #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 15, 2022
Merged

Remove unnecessary doc bits after unification #390

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2068a8c
remove unnecessary contribution page
ArnoStrouwen Aug 1, 2022
c17c63d
Delete contributing.md
ArnoStrouwen Aug 1, 2022
71df6c9
Delete docs/src/images directory
ArnoStrouwen Aug 1, 2022
39ccc49
remove logo
ArnoStrouwen Aug 1, 2022
0a92054
Finish doc unification
ArnoStrouwen Aug 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/pages.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,4 @@ pages = ["index.md"
"Gramacy & Lee Function" => "gramacylee.md",
"Salustowicz Benchmark" => "Salustowicz.md",
"Multi objective optimization" => "multi_objective_opt.md",
]
"Contributing" => "contributing.md"]
]]
17 changes: 0 additions & 17 deletions docs/src/contributing.md
View file
Open in desktop

This file was deleted.

Binary file removed docs/src/images/Surrogates.png
View file
Open in desktop
Binary file not shown.
30 changes: 19 additions & 11 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
![SurrogatesLogo](images/Surrogates.png)
# Overview
# Surrogates.jl: Surrogate models and optimization for scientific machine learning
A surrogate model is an approximation method that mimics the behavior of a computationally
expensive simulation. In more mathematical terms: suppose we are attempting to optimize a function
``\; f(p)``, but each calculation of ``\; f`` is very expensive. It may be the case that we need to solve a PDE for each point or use advanced numerical linear algebra machinery, which is usually costly. The idea is then to develop a surrogate model ``\; g`` which approximates ``\; f`` by training on previous data collected from evaluations of ``\; f``.
Expand Down Expand Up @@ -74,18 +73,27 @@ The surrogates implemented here are all automatically differentiable via Zygote.
of this property, surrogates are useful models for processes which aren't explicitly
differentiable, and can be used as layers in, for instance, Flux models.

# Installation
## Installation
Surrogates is registered in the Julia General Registry. In the REPL:
```
]add Surrogates
using Pkg
Pkg.add("Surrogates")
```

You can obtain the current master with:
```
]add https://github.com/JuliaDiffEq/Surrogates.jl#master
```

# Quick example
## Contributing

- Please refer to the
[SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md)
for guidance on PRs, issues, and other matters relating to contributing to SciML.
- See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions.
- There are a few community forums:
- The #diffeq-bridged and #sciml-bridged channels in the
[Julia Slack](https://julialang.org/slack/)
- The #diffeq-bridged and #sciml-bridged channels in the
[Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
- On the [Julia Discourse forums](https://discourse.julialang.org)
- See also [SciML Community page](https://sciml.ai/community/)

## Quick example
```@example
using Surrogates
num_samples = 10
Expand Down