Skip to content

Add constructor trait #27

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 4 commits into from
Jun 3, 2024
Merged

Add constructor trait #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b2abe5
add constructor trait
ablaom May 30, 2024
a5331b4
bump 3.3.0
ablaom May 30, 2024
f0d0685
bump 3.4
ablaom May 30, 2024
f2a602b
add fallback for `docstring(::Function)`
ablaom Jun 3, 2024
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
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "StatisticalTraits"
uuid = "64bff920-2084-43da-a3e6-9bb72801c0c9"
authors = ["Anthony D. Blaom <[email protected]>"]
version = "3.2.0"
version = "3.4.0"

[deps]
ScientificTypesBase = "30f210dd-8aff-4c5f-94ba-8e64358c1161"
Expand Down
3 changes: 3 additions & 0 deletions src/StatisticalTraits.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ const TRAITS = [
:supports_training_losses,
:deep_properties,
:reporting_operations,
:constructor,
]


Expand Down Expand Up @@ -172,6 +173,7 @@ abstract_type(::Type) = Any
is_wrapper(::Type) = false # or `true`
supports_online(::Type) = false # or `true`
docstring(M::Type) = string(M) # some `String`
docstring(Contructor::Function) = Base.Docs.doc(Constructor) |> string
is_supervised(::Type) = false # or `true`
human_name(M::Type) = snakecase(name(M), delim=' ') # `name` defined below
orientation(::Type) = :loss # or `:score`, `:other`
Expand All @@ -184,6 +186,7 @@ iteration_parameter(::Type) = nothing
supports_training_losses(::Type) = false
deep_properties(::Type) = ()
reporting_operations(::Type) = ()
constructor(::Type) = nothing

# Returns a tuple, with one entry per field of `T` (the type of some
# statistical model, for example). Each entry is `nothing` or defines
Expand Down