Hi I am testing `Remote Access` and get some basic questions

Question

Hi I am testing `Remote Access` and get some basic questions What is the right way to specify the `entity` parameter of `register workflow` or `register script` I put the function name of a workflow directly and I got a `NoneType` error Do I need to do some additional steps to convert a normal workflow to `WorkflowBase` class In addition what is the difference between `register script` and `register workflow` I checked the definition of these two functions It seems that the main difference is that `register script` provides an option to copy all files under the source path and correspondingly creates some `serialization settings` automatically Thanks ``` flyte workflows git main cat simple py import typing from flytekit import task workflow task def say hello name str gt str return f hello name task def greeting length greeting str gt int return len greeting workflow def wf name str = union gt typing Tuple str int greeting = say hello name=name greeting len = greeting length greeting=greeting return greeting greeting len if name == main print f Running wf wf name= passengers from flytekit remote import FlyteRemote from flytekit configuration import Config remote = FlyteRemote config=Config for sandbox default project= flytesnacks default domain= development remote wf = remote register workflow entity=wf remote execute entity=remote wf flyte workflows git main python simple py Traceback most recent call last Users yuanwang projects flyte test case workflows simple py 34 in lt module gt 34 remote wf = remote register workflow Users yuanwang venvs flyte lib python3 11 site packages flytekit remote remote py 743 in register workflow 743 ident = self resolve identifier ResourceType WORKFLOW entity name version se Users yuanwang venvs flyte lib python3 11 site packages flytekit remote remote py 543 in resolve identifier 543 version=version or ss version AttributeError NoneType object has no attribute version ```

Samhita Alla · Answer

Can you specify the `version` in `register workflow` Something like `version=v1`

Samhita Alla · Answer

gt what is the difference between `register script` and `register workflow` `register script` is more of like registering a task workflow via script mode meaning you need to specify the source path module name and so on And yes the copy all is useful when your workflow is dependent on some modules < Eduardo Apolinario eapolinario > in what scenarios is `register script` useful

Yuan Wang (Mike) · Answer

gt Can you specify the version in register workflow Something like version=v1 I added `version= v1 ` and seems that it passes the version check However I got another error complaining serialization settings The program is same The only difference is that `version= v1 is added to the call of `register workflow` BTW if `version` is an optional parameter why is it necessary to add it ``` flyte workflows git main python simple py Traceback most recent call last Users yuanwang projects flyte test case workflows simple py 34 in lt module gt 34 remote wf = remote register workflow Users yuanwang venvs flyte lib python3 11 site packages flytekit remote remote py 750 in register workflow 750 ident = self serialize and register entity serialization settings version op Users yuanwang venvs flyte lib python3 11 site packages flytekit remote remote py 687 in serialize and register 687 f No serialization settings set but workflow contains entities that AttributeError TaskSpec object has no attribute id ```

Samhita Alla · Answer

`version` needs to be specified as a parameter or in the serialization settings We need to improve our flyte remote docs and docstrings Contributions welcome slightly smiling face I believe `serialization settings` is a mandatory argument to specify

Samhita Alla · Answer

< Kevin Su> would you mind helping Yuan if you ve the time I ll try coming up with an example tomorrow to share it with Yuan

Kevin Su · Answer

yes need to add `SerializationSettings` ```ss = SerializationSettings image config project= flytesnacks domain= development version=version remote register workflow hello wf serialization settings=ss ```

Samhita Alla · Answer

Hi < Yuan Wang Mike > have you got it to work

Yuan Wang (Mike) · Answer

``` flyte workflows git main cat simple py import typing from flytekit import task workflow task def say hello name str gt str return f hello name task def greeting length greeting str gt int return len greeting workflow def wf name str = union gt typing Tuple str int greeting = say hello name=name greeting len = greeting length greeting=greeting return greeting greeting len if name == main from flytekit remote import FlyteRemote from flytekit configuration import Config SerializationSettings ImageConfig remote = FlyteRemote config=Config for sandbox default project= flytesnacks default domain= development ss = SerializationSettings image config=ImageConfig auto default image project= flytesnacks domain= development version= v1 remote wf = remote register workflow entity=wf serialization settings=ss remote execute entity=remote wf inputs= name mike ```

Yuan Wang (Mike) · Answer

< Samhita Alla> Thanks for your reply and coordinating Kevin for helping me out Really appreciated After adding the `SerializationSettings` object it can register and execute the workflow However I got error when running the first task of the workflow `ValueError Empty module name` Is it correct to use `ImageConfig auto default image ` to input the `image config` If I want to specify a custom image how should I do it with `ImageConfig` It would be good if some examples can be created for the If I want to use `ImageSpec` to specify the image for task execution do I still need to input a `image config` here Generally speaking is it easier to use `register script` than `register workflow` From the function definition it seems that `register script` will take care of initializing `SerializationSettings` by default I would like to contribute to the document How should I proceed with that

Samhita Alla · Answer

1 `ImageConfig auto default image ` looks correct to me 2 You can specify a custom image by sending `ImageConfig auto img name= ` 3 < Kevin Su> does image spec work with flyte remote 4 You can either use `register script` or `register workflow` IMO `register workflow` is much easier to get started 5 You can contribute to document Yuan You should just be able to fork the repo modify or add the relevant content and create a PR You can tag me by leaving a comment in the PR slightly smiling face Can you try importing the workflow in a different module and writing your flyte remote code over there Something like ```from workflows example import wf flyte remote code ```

Yuan Wang (Mike) · Answer

``` flyte workflows git main cat simple py import typing from flytekit import task workflow task def say hello name str gt str return f hello name task def greeting length greeting str gt int return len greeting workflow def wf name str = union gt typing Tuple str int greeting = say hello name=name greeting len = greeting length greeting=greeting return greeting greeting len flyte workflows git main cat flyte remote py from flytekit remote import FlyteRemote from flytekit configuration import Config SerializationSettings ImageConfig from simple import wf remote = FlyteRemote config=Config for sandbox default project= flytesnacks default domain= development ss = SerializationSettings image config=ImageConfig auto default image project= flytesnacks domain= development version= v1 remote wf = remote register workflow entity=wf serialization settings=ss remote execute entity=remote wf inputs= name mike flyte workflows git main python flyte remote py```

Yuan Wang (Mike) · Answer

< Samhita Alla> Got another kind of error

Samhita Alla · Answer

Sorry Can you share with me the directory structure

Yuan Wang (Mike) · Answer

Yes ``` flyte workflows git main tree init py flyte remote py simple py```

Samhita Alla · Answer

Can you move workflows to a different folder parent workflows init py flyte remote py simple py

Yuan Wang (Mike) · Answer

And what should be the next step Still run `python flyte remote py` within `workflows` folder

Samhita Alla · Answer

Yeah can you give that a try

Yuan Wang (Mike) · Answer

I moved it to one level up and I got the same error

Samhita Alla · Answer

Okay Can you try running the script in the parent directory or one level above that

Yuan Wang (Mike) · Answer

Got the same error if I run `python workflows flyte remote py` in the parent directory Can you reproduce the issue on your laptop

Samhita Alla · Answer

I m not sure how to resolve this issue < Kevin Su> can you help please

Samhita Alla · Answer

The error is caused because we are running the Flyte remote script with Python not pyflyte which imports and triggers the workflow As a result Flyte is unable to find the parent directory of that workflow

Samhita Alla · Answer

< Yuan Wang Mike > can you use `register script` meanwhile

Samhita Alla · Answer

`register workflow` has to work but we may need to do something to get it to work I ll try talking to the team to get it fixed

Yuan Wang (Mike) · Answer

``` workflows git main cat flyte remote register script py from flytekit remote import FlyteRemote from flytekit configuration import Config SerializationSettings ImageConfig from simple import wf remote = FlyteRemote config=Config for sandbox default project= flytesnacks default domain= development ss = SerializationSettings image config=ImageConfig auto default image project= flytesnacks domain= development version= v1 remote wf = remote register script entity=wf image config=ImageConfig auto default image version= v1 source path= module name= remote workflow remote execute entity=remote wf inputs= name mike workflows git main python flyte remote register script py Traceback most recent call last Users yuanwang projects flyte test case workflows flyte remote regist er script py 19 in lt module gt 19 remote wf = remote register script opt homebrew lib python3 11 site packages flytekit remote remote py 8 85 in register script 885 compress scripts source path str archive fname opt homebrew lib python3 11 site packages flytekit tools script mode py 48 in compress scripts 48 copy module to destination source path destination path opt homebrew lib python3 11 site packages flytekit tools script mode py 64 in copy module to destination 64 mod = importlib import module module name opt homebrew Cellar python 3 11 3 11 4 1 Frameworks Python framework Versions 3 11 lib python3 11 importlib init py 117 in import module 117 if name startswith AttributeError NoneType object has no attribute startswith ```

Yuan Wang (Mike) · Answer

If I remove the comment symbol ` ` in front of the `module name` parameter of `register script` I got another error ``` workflows git main python flyte remote register script py Traceback most recent call last Users yuanwang projects flyte test case workflows flyte remote regist er script py 19 in lt module gt 19 remote wf = remote register script opt homebrew lib python3 11 site packages flytekit remote remote py 8 85 in register script 885 compress scripts source path str archive fname opt homebrew lib python3 11 site packages flytekit tools script mode py 48 in compress scripts 48 copy module to destination source path destination path opt homebrew lib python3 11 site packages flytekit tools script mode py 64 in copy module to destination 64 mod = importlib import module module name opt homebrew Cellar python 3 11 3 11 4 1 Frameworks Python framework Versions 3 11 lib python3 11 importlib init py 126 in import module 126 return bootstrap gcd import name level package level in gcd import 1204 in find and load 1176 in find and load unlocked 1140 ModuleNotFoundError No module named remote workflow ```

Kevin Su · Answer

Sorry I missed the message I ll take a look tomorrow morning

Samhita Alla · Answer

< Yuan Wang Mike > I think the module needs to be `simple` because you have your `wf` in `simple py` right

Samhita Alla · Answer

Also here s the directory structure of the example I sent just in case you still get a module not found error <https github com flyteorg flytesnacks tree master examples feast integration feast integration>

Gaurav Kumar · Answer

Here s my code it s working fine ```root flyte remote py workflows init py simple py``` Added copy all=True in register script ```remote wf = remote register script entity=wf copy all=True version= image config=ImageConfig auto default image source path= ``` executed the following cmd inside root it worked ```python flyte remote py```

Yuan Wang (Mike) · Answer

Thanks < Gaurav Kumar> Your solution also works for me < Samhita Alla> So it seems that we have to move the file that contains `register script ` call to the parent directory of the workflows files and specify `copy all=True` and `source path= ` I tried the similar approach with `register workflow` However I got the error `ModuleNotFoundError No module named workflows ` in the flyte console This seems to me something related with `copy all` and `source path` So the question seems to be mainly about the file structure Another issue is the mandatory optional parameters of these registration functions It would be great if you guys can provide a clear description of these two questions Thanks a lot ``` test case git main tree Dockerfile LICENSE README md docker build sh flyte remote py flyte remote register script py requirements txt workflows init py simple py``` ``` test case git main cat flyte remote py from flytekit remote import FlyteRemote from flytekit configuration import Config SerializationSettings ImageConfig from workflows simple import wf remote = FlyteRemote config=Config for sandbox default project= flytesnacks default domain= development ss = SerializationSettings image config=ImageConfig auto default image project= flytesnacks domain= development version= v3 remote wf = remote register workflow entity=wf serialization settings=ss remote execute entity=remote wf inputs= name mike ``` ``` test case git main cat flyte remote register script py from flytekit remote import FlyteRemote from flytekit configuration import Config ImageConfig from workflows simple import wf remote = FlyteRemote config=Config for sandbox default project= flytesnacks default domain= development remote wf = remote register script entity=wf image config=ImageConfig auto default image version= v2 copy all=True source path= module name= workflows remote execute entity=remote wf inputs= name mike ``` ``` test case git main cat workflows simple py import typing from flytekit import task workflow task def say hello name str gt str return f hello name task def greeting length greeting str gt int return len greeting workflow def wf name str = union gt typing Tuple str int greeting = say hello name=name greeting len = greeting length greeting=greeting return greeting greeting len```

Samhita Alla · Answer

Good to know that you got `register script` to work Yuan Thanks Gaurav We ll work on improving our docs and also look into the `register workflow` method