semantic-kernel icon indicating copy to clipboard operation
semantic-kernel copied to clipboard

Python: Pythonic Design Principle in docs

Open eavanvalkenburg opened this issue 1 year ago • 2 comments

Motivation and Context

Adds the main design principle that we will use for Semantic Kernel, this will allow Python developers and dotnet developers to better understand where and why designs are changed.

Description

Contribution Checklist

eavanvalkenburg avatar Aug 06 '24 12:08 eavanvalkenburg

Python Test Coverage

Python Test Coverage Report
FileStmtsMissCoverMissing
semantic_kernel
   kernel.py157796%146, 157, 161, 311–314, 423
semantic_kernel/agents/open_ai
   open_ai_assistant_base.py385299%301–302
semantic_kernel/connectors/ai/azure_ai_inference/services
   azure_ai_inference_chat_completion.py149497%169, 312, 416, 430
semantic_kernel/connectors/ai/embeddings
   embedding_generator_base.py8188%50
semantic_kernel/connectors/ai/google
   shared_utils.py39295%100, 122
semantic_kernel/connectors/ai/google/google_ai/services
   google_ai_chat_completion.py145398%149, 251, 287
   utils.py62395%138, 156–161
semantic_kernel/connectors/ai/google/vertex_ai/services
   utils.py64395%140, 158–163
   vertex_ai_chat_completion.py145398%143, 244, 280
semantic_kernel/connectors/ai/hugging_face/services
   hf_text_completion.py54394%97, 105, 136
   hf_text_embedding.py32584%79–83
semantic_kernel/connectors/openapi_plugin
   openapi_manager.py58297%110–111
   openapi_parser.py88199%127
   openapi_runner.py105298%181–182
semantic_kernel/connectors/openapi_plugin/models
   rest_api_operation.py129199%242
semantic_kernel/contents
   function_call_content.py97199%201
semantic_kernel/functions
   kernel_function_decorator.py98199%102
   kernel_function_from_method.py96199%153
   kernel_function_from_prompt.py154795%165–166, 180, 201, 219, 239, 322
   kernel_plugin.py187299%472, 475
semantic_kernel/planners
   plan.py2344581%54, 163–165, 197, 214–227, 264, 269, 277–278, 288–291, 308, 313, 329, 332–337, 355, 360, 363, 365, 372, 386–388, 393–397
semantic_kernel/planners/function_calling_stepwise_planner
   function_calling_stepwise_planner.py116497%145, 189–190, 198
semantic_kernel/planners/sequential_planner
   sequential_planner.py64691%71, 75, 109, 125, 134–135
   sequential_planner_extensions.py50982%31–32, 56, 110–124
   sequential_planner_parser.py771284%66–74, 93, 117–120
semantic_kernel/schema
   kernel_json_schema_builder.py119596%50, 84, 206, 210–211
semantic_kernel/template_engine/blocks
   code_block.py77199%119
   named_arg_block.py43198%98
semantic_kernel/utils/telemetry
   decorators.py113496%232, 240, 243, 252
   user_agent.py16288%18–19
TOTAL864814398% 

Python Unit Test Overview

Tests Skipped Failures Errors Time
2106 1 :zzz: 0 :x: 0 :fire: 53.676s :stopwatch:

markwallace-microsoft avatar Aug 06 '24 12:08 markwallace-microsoft

Thanks for putting this together. Looks great!

moonbox3 avatar Aug 06 '24 18:08 moonbox3

Please re-open if/when we want to get this information into main.

moonbox3 avatar Nov 04 '24 16:11 moonbox3