Initial Functions Module Thread. Do not merge #17
Conversation
There was a problem hiding this comment.
OK, looks like I emerged from this black hole. 👾
Flight is kinda ok now, dark matter [except for deep-and-no-copy-stuff] is mostly cracked.
Thank you for the writing docs (really appreciated) and giving me the opportunity to find typos and improvements! (half of the comments is about them 😂 )
Remember, that if something requires explanation to me, it might be useful to do so not only in the comments, but somewhere in the code also 😄
Plus tests, tests and more tests! 😹
This is very cool in general though 👍
And now it's your turn to suffer 😈
| main() | ||
| ``` | ||
|
|
||
| Note that the `main` function defined here is optional. This project could either be run as is, or run using xun. To run the program using xun, run the following: |
There was a problem hiding this comment.
This is one of the very first lines users will read. So maybe explicitly mark the difference between running project as is and with using xun so it was clear what xun is.
Also, just calling xun without main won't print anything. As a user, where could I find the results or my computations?
| @@ -14,3 +14,179 @@ | |||
|
|
|||
| https://en.wikipedia.org/wiki/Bagua | |||
| ``` | |||
|
|
|||
There was a problem hiding this comment.
-
One-liner even before tutorial stating what xun is in general would be good.
-
Also, put a note about technical requirements. Meaning at least exactly which Python versions are supported (I think some of the attributes you use appear only from certain version)
| ```python | ||
| def fibonacci_number(n): | ||
| ``` | ||
| The function definition is just normal a python function definition. |
There was a problem hiding this comment.
-
just (a) normal
-
is it worth to separate it into its own category then?
| def compile_function_graph_builder(context, function_name): | ||
| """Compile a function graph builder | ||
|
|
||
| Make a graph builder from a context function, results are memoized |
There was a problem hiding this comment.
You can be more helpful!
- is "graph_builder" actually a scheduler? (Complicated words frighten me!)
- is it important that it is compiled or can we make understanding this easier and just say "create/make"?
so something like "create_calls_scheduler(context, function)" ?
And update the return value. "sub-dag" doesn't help too much
| return decomposed.assemble(decomposed.xun_graph).compile() | ||
|
|
||
|
|
||
| def build_function_graph(context, call): |
There was a problem hiding this comment.
create_call_schedule to be similar to previous one and confuse everyone?
(schedule_call sounds nicer but it might imply that something is already sent for execution, which is wrong)
If you agree that this makes more sense, other methods might be renamed in similar manner.
"functions graph" just doesn't tell me much.
JensGM
changed the title
No description provided.