Skip to content
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.

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

purge refs to obsolete functionality #941

Merged
merged 1 commit into from
Sep 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 12 additions & 14 deletions src/machines.jl
Original file line number Diff line number Diff line change
Expand Up @@ -788,18 +788,17 @@ Return the learned parameters for a machine `mach` that has been

This is a named tuple and human-readable if possible.

If `mach` is a machine for a composite model, such as a model
constructed using `@pipeline`, then the returned named tuple has the
composite type's field names as keys. The corresponding value is the
fitted parameters for the machine in the underlying learning network
bound to that model. (If multiple machines share the same model, then the
value is a vector.)
If `mach` is a machine for a composite model, such as a model constructed using the
pipeline syntax `model1 |> model2 |> ...`, then the returned named tuple has the composite
type's field names as keys. The corresponding value is the fitted parameters for the
machine in the underlying learning network bound to that model. (If multiple machines
share the same model, then the value is a vector.)

```julia
using MLJ
@load LogisticClassifier pkg=MLJLinearModels
X, y = @load_crabs;
pipe = @pipeline Standardizer LogisticClassifier
pipe = Standardizer() |> LogisticClassifier()
mach = machine(pipe, X, y) |> fit!

julia> fitted_params(mach).logistic_classifier
Expand Down Expand Up @@ -831,18 +830,17 @@ Return the report for a machine `mach` that has been

This is a named tuple and human-readable if possible.

If `mach` is a machine for a composite model, such as a model
constructed using `@pipeline`, then the returned named tuple has the
composite type's field names as keys. The corresponding value is the
report for the machine in the underlying learning network
bound to that model. (If multiple machines share the same model, then the
value is a vector.)
If `mach` is a machine for a composite model, such as a model constructed using the
pipeline syntax `model1 |> model2 |> ...`, then the returned named tuple has the composite
type's field names as keys. The corresponding value is the report for the machine in the
underlying learning network bound to that model. (If multiple machines share the same
model, then the value is a vector.)

```julia
using MLJ
@load LinearBinaryClassifier pkg=GLM
X, y = @load_crabs;
pipe = @pipeline Standardizer LinearBinaryClassifier
pipe = Standardizer() |> LinearBinaryClassifier()
mach = machine(pipe, X, y) |> fit!

julia> report(mach).linear_binary_classifier
Expand Down
2 changes: 1 addition & 1 deletion src/sources.jl
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The calling behaviour of a `Source` object is this:
Xs(rows=r) = selectrows(X, r) # eg, X[r,:] for a DataFrame
Xs(Xnew) = Xnew

See also: [`@from_network`](@ref), [`sources`](@ref),
See also: [`MLJBase.prefit`](@ref), [`sources`](@ref),
[`origins`](@ref), [`node`](@ref).

"""
Expand Down