Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
juliohm committed Jul 30, 2023
1 parent dc71a67 commit 7318c58
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions docs/src/user/interface.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
```@meta
DocTestSetup = quote
using LossFunctions
using LossFunctions.Traits
end
```

Expand All @@ -26,6 +27,12 @@ is available for all the different types of losses. We will
discuss how to create a loss, how to compute its value and
derivative, and how to query its properties.

```@docs
Loss
SupervisedLoss
UnsupervisedLoss
```

## Instantiating a Loss

Losses are immutable types. As such, one has to instantiate one
Expand Down Expand Up @@ -180,17 +187,20 @@ a loss. It follows a list of implemented property-functions
defined in [LearnBase.jl](https://github.com/JuliaML/LearnBase.jl).

```@docs
isdistancebased
ismarginbased
isminimizable
isdifferentiable
istwicedifferentiable
isconvex
isstrictlyconvex
isstronglyconvex
isdifferentiable
istwicedifferentiable
islocallylipschitzcont
islipschitzcont
isnemitski
isunivfishercons
isfishercons
islipschitzcont
islocallylipschitzcont
isclipable
ismarginbased
isclasscalibrated
isdistancebased
issymmetric
```

0 comments on commit 7318c58

Please sign in to comment.