Update README.md #34
Merged
Update README.md #34
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Removed the word API and replaced it with SDK Signed-off-by: Srinivasan <[email protected]>
Replaced the word API with the word SDK Signed-off-by: Srinivasan <[email protected]>
Updated the architecture of the carbonQL project Signed-off-by: Srinivasan <[email protected]>
9 tasks
README.md
Outdated
| @@ -49,6 +49,14 @@ The carbonQL acts like a facade, it might call out to other APIs, CSV files, DBs | |||
|
|
|||
| It provides a common interface to all the various models, makes opinionated decisions about which model to use and how its results should be transformed into the format you need for your calculations. In the above diagram we can see that the carbonQL is intended to connect to various backend carbon datasets like Climatiq, Cloud carbon co-efficients to bring back emissions data given the usage. | |||
|
|
|||
| The interface definition would be generic i.e irrespective of the underlying data sources (hereafter referred to as models) being used , the method names across all tge data models would be the same. This would provide uniformity to the callers or users to use the carbonQL SDK. For example some of the methods we have envisioned in the interface include : | |||
There was a problem hiding this comment.
"across all tge data" - there's a typo. Should be "the"?
There was a problem hiding this comment.
@Oleg-Zhymolokhov Fixed the issue
README.md
Outdated
| @@ -6,19 +6,19 @@ The friction to measuring software emissions isn't that we need to know how, it' | |||
|
|
|||
| ## Solution | |||
|
|
|||
| Therefore, the intent of this project is to build a single API codenamed *carbonQL* that you can use to measure your software emissions for every runtime environment. If your application runs on bare-metal servers in the private cloud, virtualized servers in the public cloud, mobile, desktop, and laptop end-user devices, the carbonQL API gives you data for all of them. | |||
| Therefore, the intent of this project is to build a SDK or a framework codenamed *carbonQL* that you can use to measure your software emissions for every runtime environment. If your application runs on bare-metal servers in the private cloud, virtualized servers in the public cloud, mobile, desktop, and laptop end-user devices, the carbonQL SDK gives you data for all of them. | |||
There was a problem hiding this comment.
"a SDK" -> "an SDK". S is pronounced as "ess".
There was a problem hiding this comment.
@Oleg-Zhymolokhov As per latest understanding, removed all references to the word SDK and replaced it with framework
Removed the word SDK and changed it to framework Addressed typos suggested by Oleg Signed-off-by: Srinivasan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Removed the word API and replaced it with SDK