From 83a6b0aa31e2a7fa72d0620dfced776a42c5e6d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Brand=C3=A3o?= Date: Fri, 21 Jul 2023 11:56:31 -0300 Subject: [PATCH 1/9] Adding Knowledge-Oriented-Framework-Milestone 3.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Project Name: A Knowledge-Oriented Approach to Enhance Integration and Communicability in the Polkadot Ecosystem Milestone 3 — Polkadot team brainstorming / workshop --- ...nowledge-Oriented-Framework-Milestone 3.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 deliveries/Knowledge-Oriented-Framework-Milestone 3.md diff --git a/deliveries/Knowledge-Oriented-Framework-Milestone 3.md b/deliveries/Knowledge-Oriented-Framework-Milestone 3.md new file mode 100644 index 000000000..1dece2927 --- /dev/null +++ b/deliveries/Knowledge-Oriented-Framework-Milestone 3.md @@ -0,0 +1,30 @@ +# Milestone Delivery :mailbox: + +> ⚡ Only the GitHub account that submitted the application is allowed to submit milestones. +> +> Don't remove any of the mandatory parts presented in bold letters or as headlines! Lines starting with `>`, such as this one, can be removed. + +**The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).** + +* **Application Document:** In the case of a public [Grants Program](https://github.com/w3f/Grants-Program) application, please provide a link to the merged contract (the `.md` file in the [applications](https://github.com/w3f/Grants-Program/tree/master/applications) directory). In the case of a private application, please provide the name of the project. +* **Milestone Number:** e.g. 1 + +**Context** (optional) +> An important aspect of creating an ontology is to engage with experts from application domains to gain their insights and perspectives. This engagement helps to ensure that the ontological framework is grounded in real-world experience and reflects the current understanding of representative personas in the applied fields. In this sense, a key step of the proposed approach is to present and discuss the ontology with the Polkadot team. + +**Deliverables** +> We wrote an article reporting the scientific findings regarding the proposed conceptual framework that includes a domain ontology called POnto (a Polkadot Ontology). POnto provides a structured representation of the ecosystem's concepts and relationships, enabling a formal understanding of the platform. The proposed knowledge-oriented approach enhances integration and communicability, enabling a wider range of users to participate in the ecosystem and facilitating the development of AI-based applications. + + + +| Number | Deliverable | Link | Notes | +| ------------- | ------------- | ------------- |------------- | +| 0a. | License |[License](https://creativecommons.org/licenses/by-sa/4.0/)|Creative Commons BY-SA| +| 0b. | Documentation/Tutorial |[CollabSession](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/collabsession_reflections.pdf) [Findings](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/article.pdf)| Collaborative Session and Reflections Scientific and Technical Findings | +| 0c. | Methodology |[Mural](https://app.mural.co/t/mobrsys8246/m/mobrsys8246/1687177222066/0657ff82c759a1e630298bfe0bef6f839249ced7?sender=uaffae0538327c8810b801518) [Questionnaire](https://docs.google.com/forms/d/e/1FAIpQLSdc6twdciTH9hF-dKiNsv5oCWoIZwbyqwuFqKNB5sPq_AA6ww/viewform?usp=pp_url) [Article](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/Article.pdf)| Methodology: see Section IV of the Article describing the Methodology | +| 0d. | Infrastructure |[TR](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/infrastructure.pdf)|Technical Report presenting the infrastructure requirements| +| 0e. | Article |[Article](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/Article.pdf)|Full article detailing scientific and technical findings achieved in the project| +| 1. | Presentation Deck |[Deck](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/collabsession_reflections.pdf)|Slide deck with reflections over the discussed content and action items| + +**Additional Information** +> This is the last milestone in the current research grant. We count on the engagement of the Polkadot community to keep evolving with the POnto specification. From 5318a8ffa7ac1f4a2fb92c3800e6a359455d6f6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Brand=C3=A3o?= Date: Fri, 21 Jul 2023 12:06:17 -0300 Subject: [PATCH 2/9] Adding Knowledge-Oriented-Framework-Milestone 3.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Project Name: A Knowledge-Oriented Approach to Enhance Integration and Communicability in the Polkadot Ecosystem Milestone 3 — Polkadot team brainstorming / workshop --- deliveries/Knowledge-Oriented-Framework-Milestone 3.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/deliveries/Knowledge-Oriented-Framework-Milestone 3.md b/deliveries/Knowledge-Oriented-Framework-Milestone 3.md index 1dece2927..aa79bd961 100644 --- a/deliveries/Knowledge-Oriented-Framework-Milestone 3.md +++ b/deliveries/Knowledge-Oriented-Framework-Milestone 3.md @@ -6,8 +6,8 @@ **The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).** -* **Application Document:** In the case of a public [Grants Program](https://github.com/w3f/Grants-Program) application, please provide a link to the merged contract (the `.md` file in the [applications](https://github.com/w3f/Grants-Program/tree/master/applications) directory). In the case of a private application, please provide the name of the project. -* **Milestone Number:** e.g. 1 +* **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/Knowledge-Oriented-Framework.md +* **Milestone Number:** 3 **Context** (optional) > An important aspect of creating an ontology is to engage with experts from application domains to gain their insights and perspectives. This engagement helps to ensure that the ontological framework is grounded in real-world experience and reflects the current understanding of representative personas in the applied fields. In this sense, a key step of the proposed approach is to present and discuss the ontology with the Polkadot team. From 1645d44fd9cc2d5717291218eed82a67d3d4d7bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Brand=C3=A3o?= Date: Fri, 21 Jul 2023 12:26:19 -0300 Subject: [PATCH 3/9] Adding Knowledge-Oriented-Framework-Milestone 3.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Project Name: A Knowledge-Oriented Approach to Enhance Integration and Communicability in the Polkadot Ecosystem Milestone 3 — Polkadot team brainstorming / workshop --- deliveries/Knowledge-Oriented-Framework-Milestone 3.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/deliveries/Knowledge-Oriented-Framework-Milestone 3.md b/deliveries/Knowledge-Oriented-Framework-Milestone 3.md index aa79bd961..4a7163f74 100644 --- a/deliveries/Knowledge-Oriented-Framework-Milestone 3.md +++ b/deliveries/Knowledge-Oriented-Framework-Milestone 3.md @@ -20,10 +20,10 @@ | Number | Deliverable | Link | Notes | | ------------- | ------------- | ------------- |------------- | | 0a. | License |[License](https://creativecommons.org/licenses/by-sa/4.0/)|Creative Commons BY-SA| -| 0b. | Documentation/Tutorial |[CollabSession](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/collabsession_reflections.pdf) [Findings](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/article.pdf)| Collaborative Session and Reflections Scientific and Technical Findings | -| 0c. | Methodology |[Mural](https://app.mural.co/t/mobrsys8246/m/mobrsys8246/1687177222066/0657ff82c759a1e630298bfe0bef6f839249ced7?sender=uaffae0538327c8810b801518) [Questionnaire](https://docs.google.com/forms/d/e/1FAIpQLSdc6twdciTH9hF-dKiNsv5oCWoIZwbyqwuFqKNB5sPq_AA6ww/viewform?usp=pp_url) [Article](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/Article.pdf)| Methodology: see Section IV of the Article describing the Methodology | +| 0b. | Documentation/Tutorial |[CollabSession](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/collabsession_reflections.pdf) [Article](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/article.pdf)| Collaborative Session and Reflections Scientific and Technical Findings | +| 0c. | Methodology |[Mural](https://app.mural.co/t/mobrsys8246/m/mobrsys8246/1687177222066/0657ff82c759a1e630298bfe0bef6f839249ced7?sender=uaffae0538327c8810b801518) [Questionnaire](https://docs.google.com/forms/d/e/1FAIpQLSdc6twdciTH9hF-dKiNsv5oCWoIZwbyqwuFqKNB5sPq_AA6ww/viewform?usp=pp_url) [Article](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/article.pdf)| Methodology: see Section IV of the Article describing the Methodology | | 0d. | Infrastructure |[TR](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/infrastructure.pdf)|Technical Report presenting the infrastructure requirements| -| 0e. | Article |[Article](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/Article.pdf)|Full article detailing scientific and technical findings achieved in the project| +| 0e. | Article |[Article](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/article.pdf)|Full article detailing scientific and technical findings achieved in the project| | 1. | Presentation Deck |[Deck](https://github.com/mobr-ai/POnto/raw/main/deliverables/milestone3/collabsession_reflections.pdf)|Slide deck with reflections over the discussed content and action items| **Additional Information** From b59617f6099186f6561872dc0503afdd7a025d3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Brand=C3=A3o=2C=20PhD?= Date: Mon, 4 Sep 2023 11:20:39 -0300 Subject: [PATCH 4/9] Adding polkadot_analytics_platform_m1.md In this milestone, we focused on constructing the foundation of the analytics platform by creating a knowledge base. We defined and implemented the base components for the dev environment that will be the basis for the proposed PAP platform. --- deliveries/polkadot_analytics_platform_m1.md | 30 ++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 deliveries/polkadot_analytics_platform_m1.md diff --git a/deliveries/polkadot_analytics_platform_m1.md b/deliveries/polkadot_analytics_platform_m1.md new file mode 100644 index 000000000..ace7aaf55 --- /dev/null +++ b/deliveries/polkadot_analytics_platform_m1.md @@ -0,0 +1,30 @@ +# Milestone Delivery :mailbox: + +> ⚡ Only the GitHub account that submitted the application is allowed to submit milestones. +> +> Don't remove any of the mandatory parts presented in bold letters or as headlines! Lines starting with `>`, such as this one, can be removed. + +**The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).** + +* **Application Document:** https://github.com/w3f/Grants-Program/pull/1883 +* **Milestone Number:** 1 + +**Context** (optional) +> The Polkadot Analytics Platform aims at building a comprehensive data analysis and visualization tool for the Polkadot ecosystem. The platform will allow users to retrieve and analyze data from various Polkadot-related sources (e.g., different parachains and components such as browser wallets), aligned with the POnto ontology [1, 2, 3]. Users will be able to specify their queries using a controlled natural language (CNL), and the platform will provide a query engine to process these queries. Additionally, the platform will provide a UI to support constructing queries and visualizing informative artifacts that represent query results. As well as support for composing customizable dashboards using these artifacts. + +> This is only the first stage in the roadmap to build the platform, which comprises a subset of the platform components + +**Deliverables** +> In this milestone, we focused on constructing the foundation of the analytics platform by creating a knowledge base. We defined and implemented the base components for the dev environment that will be the basis for the proposed platform. This included evolving with POnto to address queries from the [Data Analysis Tools for Substrate-based Blockchains](https://github.com/w3f/Grants-Program/blob/master/docs/RFPs/Under%20Development/data_analysis_tools.md) RFP and the Substrate-ETL project. An initial KB component (including triplestore database and basic API endpoint) was developed to handle operations over POnto entities. + +Project Repository: https://github.com/mobr-ai/PolkadotAnalytics + +| Number | Deliverable | Link | Notes | +| ------------- | ------------- | ------------- |------------- | +| **0a.** | Copyright and Licenses | [Apache License](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/LICENSE) | Apache 2.0 | +| **0b.** | Documentation/Tutorial | [POnto documentation](https://www.mobr.ai/ponto)

[PAP endpoints](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/pap/swagger.yml)

[source code documentation](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/pap/swagger.yml) | Online documentation of the new version of the POnto Ontology

PAP swagger Documentation

PAP source code documentation.

Refer to the README file on our repository to details about how to access the platform swagger endpoint. | +| **0c.** | Testing and Testing Guide | [Tests](https://github.com/mobr-ai/PolkadotAnalytics/tree/main/pap/tests)

[How to test](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/README.md)

[KB query guide](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/docs/kb_guide.ipynb)| PAP tests

How to run the tests

Querying the KB API: a guide on how to query and test the KB.

The README file includes details on how to run the platform as well as how to execute all of its tests | +| **0d.** | Docker | [Dockerfile](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/Dockerfile)

[docker-compose](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/docker-compose.yml) | Docker image for the KB Bootstrap. | +| **0e.** | Article | [Medium post draft](https://medium.com/@mobrsys/building-the-foundation-the-first-stage-of-the-polkadot-analytics-platform-6e9fa6fdbf33) | Medium post about the proposed platform roadmap and what we achieved so far. | +| **1.** | POnto Evolution | [POnto](https://github.com/mobr-ai/POnto)

[Technical Report](https://github.com/mobr-ai/POnto/blob/main/docs/pdf/POnto_v0.0.2_evolution_report.pdf) | New version of POnto ontology, addressing aspects from RFP and Substrate-ETL.

Technical Report describing the POnto evolution | +| **2.** | KB Bootstrap | [PAP](https://github.com/mobr-ai/PolkadotAnalytics) | Python code with KB endpoints that interact with Jena triplestore database through fuseki-server. Implementation of an initial API to handle knowledge representation. Along with, functionalities to inject the knowledge representation required to bootstrap the KB. | From c4ca7b7b16defa550efddd3d108ad98923e4a239 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Brand=C3=A3o=2C=20PhD?= Date: Mon, 4 Sep 2023 11:33:13 -0300 Subject: [PATCH 5/9] Update polkadot_analytics_platform_m1.md Fixing missing section (Additional Information) --- deliveries/polkadot_analytics_platform_m1.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/deliveries/polkadot_analytics_platform_m1.md b/deliveries/polkadot_analytics_platform_m1.md index ace7aaf55..a3bad709b 100644 --- a/deliveries/polkadot_analytics_platform_m1.md +++ b/deliveries/polkadot_analytics_platform_m1.md @@ -12,7 +12,6 @@ **Context** (optional) > The Polkadot Analytics Platform aims at building a comprehensive data analysis and visualization tool for the Polkadot ecosystem. The platform will allow users to retrieve and analyze data from various Polkadot-related sources (e.g., different parachains and components such as browser wallets), aligned with the POnto ontology [1, 2, 3]. Users will be able to specify their queries using a controlled natural language (CNL), and the platform will provide a query engine to process these queries. Additionally, the platform will provide a UI to support constructing queries and visualizing informative artifacts that represent query results. As well as support for composing customizable dashboards using these artifacts. -> This is only the first stage in the roadmap to build the platform, which comprises a subset of the platform components **Deliverables** > In this milestone, we focused on constructing the foundation of the analytics platform by creating a knowledge base. We defined and implemented the base components for the dev environment that will be the basis for the proposed platform. This included evolving with POnto to address queries from the [Data Analysis Tools for Substrate-based Blockchains](https://github.com/w3f/Grants-Program/blob/master/docs/RFPs/Under%20Development/data_analysis_tools.md) RFP and the Substrate-ETL project. An initial KB component (including triplestore database and basic API endpoint) was developed to handle operations over POnto entities. @@ -28,3 +27,6 @@ Project Repository: https://github.com/mobr-ai/PolkadotAnalytics | **0e.** | Article | [Medium post draft](https://medium.com/@mobrsys/building-the-foundation-the-first-stage-of-the-polkadot-analytics-platform-6e9fa6fdbf33) | Medium post about the proposed platform roadmap and what we achieved so far. | | **1.** | POnto Evolution | [POnto](https://github.com/mobr-ai/POnto)

[Technical Report](https://github.com/mobr-ai/POnto/blob/main/docs/pdf/POnto_v0.0.2_evolution_report.pdf) | New version of POnto ontology, addressing aspects from RFP and Substrate-ETL.

Technical Report describing the POnto evolution | | **2.** | KB Bootstrap | [PAP](https://github.com/mobr-ai/PolkadotAnalytics) | Python code with KB endpoints that interact with Jena triplestore database through fuseki-server. Implementation of an initial API to handle knowledge representation. Along with, functionalities to inject the knowledge representation required to bootstrap the KB. | + +**Additional Information** +> This is only the first stage in the roadmap to build the platform, which comprises a subset of the platform components From db31fc634471c44a6bdbe94f475a7f2594bb392e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Brand=C3=A3o?= Date: Mon, 4 Sep 2023 11:41:33 -0300 Subject: [PATCH 6/9] Removing milestone deliverable --- deliveries/polkadot_analytics_platform_m1.md | 32 -------------------- 1 file changed, 32 deletions(-) delete mode 100644 deliveries/polkadot_analytics_platform_m1.md diff --git a/deliveries/polkadot_analytics_platform_m1.md b/deliveries/polkadot_analytics_platform_m1.md deleted file mode 100644 index a3bad709b..000000000 --- a/deliveries/polkadot_analytics_platform_m1.md +++ /dev/null @@ -1,32 +0,0 @@ -# Milestone Delivery :mailbox: - -> ⚡ Only the GitHub account that submitted the application is allowed to submit milestones. -> -> Don't remove any of the mandatory parts presented in bold letters or as headlines! Lines starting with `>`, such as this one, can be removed. - -**The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).** - -* **Application Document:** https://github.com/w3f/Grants-Program/pull/1883 -* **Milestone Number:** 1 - -**Context** (optional) -> The Polkadot Analytics Platform aims at building a comprehensive data analysis and visualization tool for the Polkadot ecosystem. The platform will allow users to retrieve and analyze data from various Polkadot-related sources (e.g., different parachains and components such as browser wallets), aligned with the POnto ontology [1, 2, 3]. Users will be able to specify their queries using a controlled natural language (CNL), and the platform will provide a query engine to process these queries. Additionally, the platform will provide a UI to support constructing queries and visualizing informative artifacts that represent query results. As well as support for composing customizable dashboards using these artifacts. - - -**Deliverables** -> In this milestone, we focused on constructing the foundation of the analytics platform by creating a knowledge base. We defined and implemented the base components for the dev environment that will be the basis for the proposed platform. This included evolving with POnto to address queries from the [Data Analysis Tools for Substrate-based Blockchains](https://github.com/w3f/Grants-Program/blob/master/docs/RFPs/Under%20Development/data_analysis_tools.md) RFP and the Substrate-ETL project. An initial KB component (including triplestore database and basic API endpoint) was developed to handle operations over POnto entities. - -Project Repository: https://github.com/mobr-ai/PolkadotAnalytics - -| Number | Deliverable | Link | Notes | -| ------------- | ------------- | ------------- |------------- | -| **0a.** | Copyright and Licenses | [Apache License](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/LICENSE) | Apache 2.0 | -| **0b.** | Documentation/Tutorial | [POnto documentation](https://www.mobr.ai/ponto)

[PAP endpoints](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/pap/swagger.yml)

[source code documentation](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/pap/swagger.yml) | Online documentation of the new version of the POnto Ontology

PAP swagger Documentation

PAP source code documentation.

Refer to the README file on our repository to details about how to access the platform swagger endpoint. | -| **0c.** | Testing and Testing Guide | [Tests](https://github.com/mobr-ai/PolkadotAnalytics/tree/main/pap/tests)

[How to test](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/README.md)

[KB query guide](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/docs/kb_guide.ipynb)| PAP tests

How to run the tests

Querying the KB API: a guide on how to query and test the KB.

The README file includes details on how to run the platform as well as how to execute all of its tests | -| **0d.** | Docker | [Dockerfile](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/Dockerfile)

[docker-compose](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/docker-compose.yml) | Docker image for the KB Bootstrap. | -| **0e.** | Article | [Medium post draft](https://medium.com/@mobrsys/building-the-foundation-the-first-stage-of-the-polkadot-analytics-platform-6e9fa6fdbf33) | Medium post about the proposed platform roadmap and what we achieved so far. | -| **1.** | POnto Evolution | [POnto](https://github.com/mobr-ai/POnto)

[Technical Report](https://github.com/mobr-ai/POnto/blob/main/docs/pdf/POnto_v0.0.2_evolution_report.pdf) | New version of POnto ontology, addressing aspects from RFP and Substrate-ETL.

Technical Report describing the POnto evolution | -| **2.** | KB Bootstrap | [PAP](https://github.com/mobr-ai/PolkadotAnalytics) | Python code with KB endpoints that interact with Jena triplestore database through fuseki-server. Implementation of an initial API to handle knowledge representation. Along with, functionalities to inject the knowledge representation required to bootstrap the KB. | - -**Additional Information** -> This is only the first stage in the roadmap to build the platform, which comprises a subset of the platform components From 2f6ac499b1adf0702d91cc041561fcc71b49bff8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Brand=C3=A3o?= Date: Mon, 4 Sep 2023 11:53:06 -0300 Subject: [PATCH 7/9] Adding polkadot_analytics_platform_m1.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Project Name: Polkadot Analytics Platform. Milestone 1 — Knowledge-Base bootstrap --- deliveries/polkadot_analytics_platform_m1.md | 27 ++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 deliveries/polkadot_analytics_platform_m1.md diff --git a/deliveries/polkadot_analytics_platform_m1.md b/deliveries/polkadot_analytics_platform_m1.md new file mode 100644 index 000000000..fb6dd72a6 --- /dev/null +++ b/deliveries/polkadot_analytics_platform_m1.md @@ -0,0 +1,27 @@ +# Milestone Delivery :mailbox: + +**The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).** + +* **Application Document:** https://github.com/w3f/Grants-Program/pull/1883 +* **Milestone Number:** 1 + +**Context** (optional) +> The Polkadot Analytics Platform aims at building a comprehensive data analysis and visualization tool for the Polkadot ecosystem. The platform will allow users to retrieve and analyze data from various Polkadot-related sources (e.g., different parachains and components such as browser wallets), aligned with the POnto ontology [1, 2, 3]. Users will be able to specify their queries using a controlled natural language (CNL), and the platform will provide a query engine to process these queries. Additionally, the platform will provide a UI to support constructing queries and visualizing informative artifacts that represent query results. As well as support for composing customizable dashboards using these artifacts. + +**Deliverables** +> In this milestone, we focused on constructing the foundation of the analytics platform by creating a knowledge base. We defined and implemented the base components for the dev environment that will be the basis for the proposed platform. This included evolving with POnto to address queries from the [Data Analysis Tools for Substrate-based Blockchains](https://github.com/w3f/Grants-Program/blob/master/docs/RFPs/Under%20Development/data_analysis_tools.md) RFP and the Substrate-ETL project. An initial KB component (including triplestore database and basic API endpoint) was developed to handle operations over POnto entities. + +Project Repository: https://github.com/mobr-ai/PolkadotAnalytics + +| Number | Deliverable | Link | Notes | +| ------------- | ------------- | ------------- |------------- | +| **0a.** | Copyright and Licenses | [Apache License](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/LICENSE) | Apache 2.0 | +| **0b.** | Documentation/Tutorial | [POnto documentation](https://www.mobr.ai/ponto)

[PAP endpoints](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/pap/swagger.yml)

[source code documentation](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/pap/swagger.yml) | Online documentation of the new version of the POnto Ontology

PAP swagger Documentation

PAP source code documentation.

Refer to the README file on our repository to details about how to access the platform swagger endpoint. | +| **0c.** | Testing and Testing Guide | [Tests](https://github.com/mobr-ai/PolkadotAnalytics/tree/main/pap/tests)

[How to test](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/README.md)

[KB query guide](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/docs/kb_guide.ipynb)| PAP tests

How to run the tests

Querying the KB API: a guide on how to query and test the KB.

The README file includes details on how to run the platform as well as how to execute all of its tests | +| **0d.** | Docker | [Dockerfile](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/Dockerfile)

[docker-compose](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/docker-compose.yml) | Docker image for the KB Bootstrap. | +| **0e.** | Article | [Medium post draft](https://medium.com/@mobrsys/building-the-foundation-the-first-stage-of-the-polkadot-analytics-platform-6e9fa6fdbf33) | Medium post about the proposed platform roadmap and what we achieved so far. | +| **1.** | POnto Evolution | [POnto](https://github.com/mobr-ai/POnto)

[Technical Report](https://github.com/mobr-ai/POnto/blob/main/docs/pdf/POnto_v0.0.2_evolution_report.pdf) | New version of POnto ontology, addressing aspects from RFP and Substrate-ETL.

Technical Report describing the POnto evolution | +| **2.** | KB Bootstrap | [PAP](https://github.com/mobr-ai/PolkadotAnalytics) | Python code with KB endpoints that interact with Jena triplestore database through fuseki-server. Implementation of an initial API to handle knowledge representation. Along with, functionalities to inject the knowledge representation required to bootstrap the KB. | + +**Additional Information** +> This is only the first stage in the roadmap to build the platform, which comprises a subset of the platform components \ No newline at end of file From 1f4769c5cceb3cb84002360a644f945d4250ad1f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Brand=C3=A3o?= Date: Mon, 4 Sep 2023 12:03:44 -0300 Subject: [PATCH 8/9] Fixing application link --- deliveries/polkadot_analytics_platform_m1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deliveries/polkadot_analytics_platform_m1.md b/deliveries/polkadot_analytics_platform_m1.md index fb6dd72a6..4a6266b54 100644 --- a/deliveries/polkadot_analytics_platform_m1.md +++ b/deliveries/polkadot_analytics_platform_m1.md @@ -2,7 +2,7 @@ **The [invoice form :pencil:](https://docs.google.com/forms/d/e/1FAIpQLSfmNYaoCgrxyhzgoKQ0ynQvnNRoTmgApz9NrMp-hd8mhIiO0A/viewform) has been filled out correctly for this milestone and the delivery is according to the official [milestone delivery guidelines](https://github.com/w3f/Grants-Program/blob/master/docs/Support%20Docs/milestone-deliverables-guidelines.md).** -* **Application Document:** https://github.com/w3f/Grants-Program/pull/1883 +* **Application Document:** https://github.com/w3f/Grants-Program/blob/master/applications/polkadot_analytics_platform.md * **Milestone Number:** 1 **Context** (optional) From 127aef9d0f6392f0097021b2bd883a0b6186b3a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20Brand=C3=A3o=2C=20PhD?= Date: Mon, 4 Sep 2023 14:51:37 -0300 Subject: [PATCH 9/9] Update polkadot_analytics_platform_m1.md Fixing URL to python documentation --- deliveries/polkadot_analytics_platform_m1.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/deliveries/polkadot_analytics_platform_m1.md b/deliveries/polkadot_analytics_platform_m1.md index 4a6266b54..9e50c346b 100644 --- a/deliveries/polkadot_analytics_platform_m1.md +++ b/deliveries/polkadot_analytics_platform_m1.md @@ -16,7 +16,7 @@ Project Repository: https://github.com/mobr-ai/PolkadotAnalytics | Number | Deliverable | Link | Notes | | ------------- | ------------- | ------------- |------------- | | **0a.** | Copyright and Licenses | [Apache License](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/LICENSE) | Apache 2.0 | -| **0b.** | Documentation/Tutorial | [POnto documentation](https://www.mobr.ai/ponto)

[PAP endpoints](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/pap/swagger.yml)

[source code documentation](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/pap/swagger.yml) | Online documentation of the new version of the POnto Ontology

PAP swagger Documentation

PAP source code documentation.

Refer to the README file on our repository to details about how to access the platform swagger endpoint. | +| **0b.** | Documentation/Tutorial | [POnto documentation](https://www.mobr.ai/ponto)

[PAP endpoints](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/pap/swagger.yml)

[source code documentation](https://github.com/mobr-ai/PolkadotAnalytics/tree/main/docs/pap) | Online documentation of the new version of the POnto Ontology

PAP swagger Documentation

PAP source code documentation.

Refer to the README file on our repository to details about how to access the platform swagger endpoint. | | **0c.** | Testing and Testing Guide | [Tests](https://github.com/mobr-ai/PolkadotAnalytics/tree/main/pap/tests)

[How to test](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/README.md)

[KB query guide](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/docs/kb_guide.ipynb)| PAP tests

How to run the tests

Querying the KB API: a guide on how to query and test the KB.

The README file includes details on how to run the platform as well as how to execute all of its tests | | **0d.** | Docker | [Dockerfile](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/Dockerfile)

[docker-compose](https://github.com/mobr-ai/PolkadotAnalytics/blob/main/docker-compose.yml) | Docker image for the KB Bootstrap. | | **0e.** | Article | [Medium post draft](https://medium.com/@mobrsys/building-the-foundation-the-first-stage-of-the-polkadot-analytics-platform-6e9fa6fdbf33) | Medium post about the proposed platform roadmap and what we achieved so far. | @@ -24,4 +24,4 @@ Project Repository: https://github.com/mobr-ai/PolkadotAnalytics | **2.** | KB Bootstrap | [PAP](https://github.com/mobr-ai/PolkadotAnalytics) | Python code with KB endpoints that interact with Jena triplestore database through fuseki-server. Implementation of an initial API to handle knowledge representation. Along with, functionalities to inject the knowledge representation required to bootstrap the KB. | **Additional Information** -> This is only the first stage in the roadmap to build the platform, which comprises a subset of the platform components \ No newline at end of file +> This is only the first stage in the roadmap to build the platform, which comprises a subset of the platform components