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

chore: rename algo to function #264

Merged
merged 10 commits into from
Feb 10, 2023
Merged

chore: rename algo to function #264

merged 10 commits into from
Feb 10, 2023

Conversation

Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
Copy link
Contributor

@RomainGoussault RomainGoussault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

Why did you add these submodules:
image

@@ -83,7 +83,7 @@
#
# - Data cannot be seen once it's registered on the platform.
# - Metadata are visible by all the users of a channel.
# - Permissions allow you to execute an algorithm on a certain dataset.
# - Permissions allow you to execute an functionrithm on a certain dataset.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# - Permissions allow you to execute an functionrithm on a certain dataset.
# - Permissions allow you to execute a function on a certain dataset.

@@ -5,14 +5,14 @@ In Substra, users create tasks that are registered to the platform, then execute

A task needs a valid Dockerfile to create a container and expose a command line interface. The execution of the command creates the expected output files.

For example, an algo defines a list of inputs and outputs. At the task execution, the inputs files are given to the container, the paths to the files are given as arguments to the command line, and the task is responsible for creating the output files.
For example, an function defines a list of inputs and outputs. At the task execution, the inputs files are given to the container, the paths to the files are given as arguments to the command line, and the task is responsible for creating the output files.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For example, an function defines a list of inputs and outputs. At the task execution, the inputs files are given to the container, the paths to the files are given as arguments to the command line, and the task is responsible for creating the output files.
For example, a function defines a list of inputs and outputs. At the task execution, the inputs files are given to the container, the paths to the files are given as arguments to the command line, and the task is responsible for creating the output files.

# ===========
# An algorithm specifies the method to train a model on a dataset or the method to aggregate models.
# Concretely, an algorithm corresponds to an archive (tar or zip file) containing:
# An functionrithm specifies the method to train a model on a dataset or the method to aggregate models.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# An functionrithm specifies the method to train a model on a dataset or the method to aggregate models.
# A function specifies the method to train a model on a dataset or the method to aggregate models.

# An algorithm specifies the method to train a model on a dataset or the method to aggregate models.
# Concretely, an algorithm corresponds to an archive (tar or zip file) containing:
# An functionrithm specifies the method to train a model on a dataset or the method to aggregate models.
# Concretely, an functionrithm corresponds to an archive (tar or zip file) containing:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Concretely, an functionrithm corresponds to an archive (tar or zip file) containing:
# Concretely, a function corresponds to an archive (tar or zip file) containing:

examples/titanic_example/run_titanic.py Outdated Show resolved Hide resolved
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy
Copy link
Member Author

Thanks for the PR!

Why did you add these submodules: image

Oups that come from the fact that I built the doc modifying the conf.py file... thanks for the catch, and for the review !

Copy link
Contributor

@RomainGoussault RomainGoussault left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: ThibaultFy <50656860+ThibaultFy@users.noreply.github.com>
@ThibaultFy ThibaultFy merged commit 133d72f into main Feb 10, 2023
@ThibaultFy ThibaultFy deleted the rename-algo-to-function branch February 10, 2023 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants