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

UDF vs UDP confusion #353

Open
soxofaan opened this issue Jan 14, 2021 · 6 comments
Open

UDF vs UDP confusion #353

soxofaan opened this issue Jan 14, 2021 · 6 comments

Comments

@soxofaan
Copy link
Member

When supporting new openEO users I noticed that it is very easy to confuse the concepts of UDFs (user defined functions) and UDPs (user defined processes). Not only their abbreviation is very close, also the conceptual difference between "function" and "process" in the context of openEO is hard to grasp when you are just starting to learn openEO (e.g. we probably explain somewhere that an openEO "process" is like a "function" in regular programming language).

I think we should consider renaming at least one of them.
I don't have a proposal at the moment, but just wanted to raise this issue here to start a discussion.

@m-mohr
Copy link
Member

m-mohr commented Jan 14, 2021

Indeed, that can be confusing. I'm trying to avoid UDP and just write "process" in commmunication, but on the other hand I never liked the term UDF. That seems to be taken from database terminology, but "function" seems to be wrong with regards to what we offer...

@edzer
Copy link
Member

edzer commented Jan 14, 2021

Maybe, instead of UDF, "script", as of "Python- or R-script"?

@m-mohr
Copy link
Member

m-mohr commented Jan 14, 2021

@edzer I thought the same, but would that just be "openEO script" or "UDS" then?

@soxofaan
Copy link
Member Author

to estimate scope and impact:

  • openeo-api/openapi.yaml:
    • 76 occurrences of user.defined.*?process, no occurrence of UDP
    • 22 occurrences of UDF, 1 occurrence of user.defined.*?function
  • openeo-processes:
    • 4 occurences of user.defined.*?process, no occurrence of UDP
    • 63 occurences of UDF, 1 occurrence of user.defined.*?function
  • openeo-python-client (user facing code and docs):
    • 60 occurrences of user.?defined.*?process, no occurence of UDP
    • 206 occurences of UDF, 6 occurences of user.?defined.*?function

@m-mohr
Copy link
Member

m-mohr commented Jan 14, 2021

This issue should get through PSC vote if there's a desire to change one of the terms, I think.

@m-mohr
Copy link
Member

m-mohr commented Jan 15, 2021

Just realized: Renaming UDF would "require" a rename for the endpoint /udf_runtimes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants