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

docs: add specification of executor and flow yaml #4795

Merged
merged 5 commits into from
May 23, 2022
Merged

Conversation

JohannesMessner
Copy link
Contributor

@JohannesMessner JohannesMessner commented May 17, 2022

TODO:

  • mention environment variables and internal links

@JohannesMessner JohannesMessner linked an issue May 17, 2022 that may be closed by this pull request
2 tasks
@github-actions github-actions bot added size/S area/docs This issue/PR affects the docs labels May 17, 2022
@github-actions
Copy link

github-actions bot commented May 17, 2022

Latency summary

Current PR yields:

  • 😶 index QPS at 1323, delta to last 2 avg.: +2%
  • 😶 query QPS at 71, delta to last 2 avg.: +0%
  • 🐎🐎 avg flow time within 1.5263 seconds, delta to last 2 avg.: +6%
  • 😶 import jina within 0.4819 seconds, delta to last 2 avg.: +0%

Breakdown

Version Index QPS Query QPS Avg Flow Time (s) Import Time (s)
current 1323 71 1.5263 0.4819
3.4.4 1386 77 1.5665 0.4443
3.4.3 1196 65 1.3025 0.5194

Backed by latency-tracking. Further commits will update this comment.

@JohannesMessner JohannesMessner self-assigned this May 18, 2022
Comment on lines 20 to 22
metas:
- py_modules:
- executor.py
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This patterns does not seem to work. But also not sure if we even want to promote it. Reason: People should probably have yaml files for their executors anyways, and those would include py_modules already.

Copy link
Member

Choose a reason for hiding this comment

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

then remove if it does not seem to work

@JohannesMessner JohannesMessner marked this pull request as ready for review May 18, 2022 15:29
docs/fundamentals/flow/yaml-spec.md Outdated Show resolved Hide resolved
@JohannesMessner JohannesMessner marked this pull request as draft May 19, 2022 13:44
@github-actions
Copy link

📝 Docs are deployed on https://docs-yaml-spec--jina-docs.netlify.app 🎉

@JohannesMessner JohannesMessner marked this pull request as ready for review May 23, 2022 09:11
@JoanFM JoanFM merged commit 3a7d95b into master May 23, 2022
@JoanFM JoanFM deleted the docs-yaml-spec branch May 23, 2022 09:15
@samsja samsja mentioned this pull request May 23, 2022
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs This issue/PR affects the docs size/M size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the Flow yaml spec
2 participants