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

Create ADR for project versioning #805

Merged
merged 6 commits into from
May 8, 2024

Conversation

frtibble
Copy link
Contributor

@frtibble frtibble commented May 3, 2024

Purpose

Creates an ADR for deciding on option for versioning of project and different approaches considered.

Does this introduce a breaking change?

  • Yes
  • No

Pull Request Type

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Documentation content changes
  • Other... Please describe:

How to Test

n/a

Copy link

github-actions bot commented May 3, 2024

Coverage

Coverage Report
FileStmtsMissCoverMissing
code
   app.py14140%1–4, 6–7, 9, 12–14, 16, 18, 20–21
   create_app.py148397%199, 204, 327
code/backend
   Admin.py21210%1–5, 7, 9–10, 12, 15–16, 18–19, 22, 29, 36, 39–41, 43, 45
code/backend/batch
   AddURLEmbeddings.py28292%32–33
   BatchPushResults.py250100% 
   BatchStartProcessing.py190100% 
   GetConversationResponse.py32390%63–65
   function_app.py16160%1–8, 10, 12–13, 15, 18–21
code/backend/batch/utilities/common
   Answer.py24195%39
   SourceDocument.py59493%33, 37, 41, 130
code/backend/batch/utilities/document_chunking
   DocumentChunkingBase.py10280%10, 16
   FixedSizeOverlap.py190100% 
   Layout.py190100% 
   Page.py170100% 
   Paragraph.py990%1–4, 7–9, 12, 15
   Strategies.py29582%24–25, 27, 29, 46
   __init__.py70100% 
code/backend/batch/utilities/document_loading
   DocumentLoadingBase.py9188%13
   Layout.py12120%1–4, 7–9, 11–13, 16, 25
   Read.py12120%1–4, 7–9, 11–13, 16, 25
   Strategies.py20860%13, 15, 17, 19, 24–25, 27, 29
   Web.py19194%23
   WordDocument.py25250%1–6, 9–12, 21–24, 26–27, 29–30, 32–37, 45
   __init__.py15193%16
code/backend/batch/utilities/helpers
   AzureBlobStorageClient.py803062%22–24, 32, 52, 55–56, 61, 65, 90–91, 93, 97, 153, 156, 175, 178, 180, 188–192, 215, 219–223, 225
   AzureFormRecognizerHelper.py81810%1–6, 9–11, 13, 16–17, 25, 27, 35, 43–45, 52–55, 60–68, 70, 73–75, 77–78, 81, 84–86, 88–90, 93, 97–98, 105–109, 111–114, 117–131, 133, 135–137, 139–140, 143, 145–147
   AzureSearchHelper.py200100% 
   DocumentChunkingHelper.py12191%21
   DocumentLoadingHelper.py12191%14
   EnvHelper.py1251092%202, 207–208, 211–213, 222, 226–228
   LLMHelper.py401172%40–41, 50, 61–62, 73, 86–87, 94, 104, 112
   OrchestratorHelper.py12466%20–22, 25
code/backend/batch/utilities/helpers/config
   ConfigHelper.py1220100% 
   EmbeddingConfig.py12191%27
code/backend/batch/utilities/helpers/embedders
   EmbedderBase.py5180%7
   EmbedderFactory.py10370%12–13, 15
   IntegratedVectorizationEmbedder.py31487%20, 39–41
   PushEmbedder.py42588%24–25, 51–53
code/backend/batch/utilities/integrated_vectorization
   AzureSearchDatasource.py190100% 
   AzureSearchIndex.py350100% 
   AzureSearchIndexer.py20290%47–48
   AzureSearchSkillset.py220100% 
code/backend/batch/utilities/loggers
   ConversationLogger.py362822%8, 11–12, 15–24, 27–30, 33–42, 46
   TokenLogger.py9277%11, 15
code/backend/batch/utilities/orchestrator
   LangChainAgent.py601968%21–24, 26, 61–62, 82–85, 102–103, 106–109, 116–117
   OpenAIFunctions.py54540%1–3, 5–10, 12, 15–18, 53, 57–59, 62, 64, 70–73, 75, 78, 85–89, 93–94, 96, 102–106, 110–112, 115, 118–119, 122, 127–129, 132–134, 137, 142
   OrchestratorBase.py52884%35, 74–76, 83–85, 95
   SemanticKernel.py520100% 
   Strategies.py161037%11–12, 14–16, 18–20, 22, 24
   __init__.py110100% 
code/backend/batch/utilities/parser
   OutputParserTool.py390100% 
   ParserBase.py9277%9, 19
   __init__.py7271%7, 11
code/backend/batch/utilities/plugins
   ChatPlugin.py150100% 
   PostAnsweringPlugin.py80100% 
code/backend/batch/utilities/search
   AzureSearchHandler.py40197%13
   IntegratedVectorizationSearchHandler.py430100% 
   Search.py33390%16, 21–22
   SearchHandlerBase.py29872%11, 15, 19, 23, 27, 31, 35, 39
code/backend/batch/utilities/tools
   AnswerProcessingBase.py8275%8, 12
   AnsweringToolBase.py9277%9, 15
   ContentSafetyChecker.py412539%16, 18–19, 24, 30–32, 35–36, 42–43, 49–54, 57–59, 61, 65–67, 69
   PostPromptTool.py221340%11, 14–15, 17–18, 22, 29, 36–37, 45, 51–52, 60
   QuestionAnswerTool.py620100% 
   TextProcessingTool.py16943%9, 12–15, 21, 23, 30, 37
code/backend/pages
   01_Ingest_Data.py88880%1–12, 14–16, 18, 24, 31, 34–35, 38–47, 51–53, 56–59, 61, 64, 67–73, 76–79, 82–89, 92–94, 96, 99–102, 105, 110–112, 114–115, 117–118, 121–122, 126, 129–130, 136–139, 146–147, 152, 158–159
   02_Explore_Data.py26260%1–7, 9–10, 12, 18, 25, 28, 36, 38–39, 41–44, 46–49, 52–53
   03_Delete_Data.py37370%1–7, 9–11, 13, 19, 26, 29, 37, 39–41, 43–46, 48, 50–51, 55, 59–63, 65, 68–69, 71–73
   04_Configuration.py1351350%1–9, 11–12, 14, 21, 28, 30, 35–44, 47–48, 51–62, 64–65, 67–69, 73–74, 86–90, 93–94, 98–100, 103–104, 107–108, 111–112, 135, 137–138, 140–144, 146–149, 152–156, 163–164, 174–176, 178, 198–199, 201, 203, 209, 217, 225, 232–233, 240, 242–243, 247, 255, 261, 268, 286–290, 296–297, 316–317, 321, 323–324, 347, 381–382, 384–385, 388–389, 392–395, 397–398, 400–402, 404–407, 409–410
TOTAL226576866% 

Tests Skipped Failures Errors Time
166 0 💤 0 ❌ 0 🔥 10.402s ⏱️

Copy link
Collaborator

@superhindupur superhindupur left a comment

Choose a reason for hiding this comment

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

Really appreciate your work on this @frtibble! I've left some thoughts just to start a discussion - not prescribing anything, just curious to hear your point of view and the rest of the team's. Thanks! ❤️

docs/design/adrs/2024-05-02-enable-project-versioning Outdated Show resolved Hide resolved
Copy link
Collaborator

@cecheta cecheta left a comment

Choose a reason for hiding this comment

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

Thanks for looking into this

docs/design/adrs/2024-05-02-enable-project-versioning Outdated Show resolved Hide resolved
docs/design/adrs/2024-05-02-enable-project-versioning Outdated Show resolved Hide resolved
docs/design/adrs/2024-05-02-enable-project-versioning Outdated Show resolved Hide resolved
Copy link
Contributor

@gaurarpit gaurarpit left a comment

Choose a reason for hiding this comment

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

some small comments

superhindupur
superhindupur previously approved these changes May 7, 2024
@frtibble frtibble linked an issue May 7, 2024 that may be closed by this pull request
9 tasks
@frtibble frtibble mentioned this pull request May 7, 2024
9 tasks
@adamdougal
Copy link
Collaborator

adamdougal commented May 8, 2024

This LGTM! Is it worth a spike + demo to see the tools in action before we go ahead?

gaurarpit
gaurarpit previously approved these changes May 8, 2024
Copy link
Contributor

@gaurarpit gaurarpit left a comment

Choose a reason for hiding this comment

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

LGTM

@frtibble frtibble dismissed stale reviews from gaurarpit and superhindupur via 7b2e459 May 8, 2024 10:03
@frtibble
Copy link
Contributor Author

frtibble commented May 8, 2024

This LGTM! Is it worth a spike + demo to see the tools in action before we go ahead?

Thanks @adamdougal your comment was what encouraged me to demo in the meeting in fact!

Copy link
Collaborator

@ross-p-smith ross-p-smith left a comment

Choose a reason for hiding this comment

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

💖

@frtibble frtibble added this pull request to the merge queue May 8, 2024
Merged via the queue into Azure-Samples:main with commit 79ef94b May 8, 2024
5 checks passed
@frtibble frtibble deleted the versioning-adr branch May 8, 2024 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add versioning to project
6 participants