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

[DOC]: Not working links in documentation #168

Merged
merged 2 commits into from
Sep 5, 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/changes/newsfragments/168.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix cross-referencing links in documentation by `Synchon Mandal`_
10 changes: 5 additions & 5 deletions julearn/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,18 @@ def run_cross_validation(
----------
X : str, list(str) or numpy.array
The features to use.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
y : str or numpy.array
The targets to predict.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
model : str or scikit-learn compatible model.
If string, it will use one of the available models.
X_types : dict[str, list of str]
A dictionary containing keys with column type as a str and the
columns of this column type as a list of str.
data : pandas.DataFrame | None
DataFrame with the data (optional).
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
problem_type : str
The kind of problem to model.

Expand Down Expand Up @@ -108,7 +108,7 @@ def run_cross_validation(

groups : str or numpy.array | None
The grouping labels in case a Group CV is used.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
scoring : ScorerLike, optional
The scoring metric to use.
See https://scikit-learn.org/stable/modules/model_evaluation.html for
Expand Down Expand Up @@ -141,7 +141,7 @@ def run_cross_validation(
* 'scoring': If a searcher is going to be used, the scoring metric to
evaluate the performance.

See https://juaml.github.io/julearn/hyperparameters.html for details.
See :ref:`hp_tuning` for details.
seed : int | None
If not None, set the random seed before any operation. Useful for
reproducibility.
Expand Down
24 changes: 12 additions & 12 deletions julearn/prepare.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ def _validate_input_data_df(
----------
X : str, list(str)
The features to use.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
y : str
The targets to predict.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
df : pandas.DataFrame with the data.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
groups : str | None
The grouping labels in case a Group CV is used.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.

Raises
------
Expand Down Expand Up @@ -78,15 +78,15 @@ def _validate_input_data_df_ext(
----------
X : str, list(str)
The features to use.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
y : str
The targets to predict.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
df : pandas.DataFrame with the data.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
groups : str | None
The grouping labels in case a Group CV is used.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.

Raises
------
Expand Down Expand Up @@ -217,18 +217,18 @@ def prepare_input_data(
----------
X : str, list(str)
The features to use.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
y : str
The targets to predict.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
df : pandas.DataFrame with the data.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
pos_labels : str, int, float or list | None
The labels to interpret as positive. If not None, every element from y
will be converted to 1 if is equal or in pos_labels and to 0 if not.
groups : str | None
The grouping labels in case a Group CV is used.
See https://juaml.github.io/julearn/input.html for details.
See :ref:`data_usage` for details.
X_types : dict | None
A dictionary containing keys with column type as a str and the
columns of this column type as a list of str.
Expand Down