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: case study on flint cloud #339

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Namyalg
Copy link
Member

@Namyalg Namyalg commented Jul 6, 2022

Pull Request Template

Description

This PR is a Case study on FLINT Cloud

Fixes #338

Case study preview : https://contributor-website-v2-git-fork-namyalg-flin-45222d-moja-global.vercel.app/case-studies/flint-cloud

Type of change

  • This change requires a documentation update.

cc : @aornugent @shubhamkarande13 @chicken-biryani @HarshCasper

@vercel
Copy link

vercel bot commented Jul 6, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
contributor-website-v2 ✅ Ready (Inspect) Visit Preview Aug 13, 2022 at 6:17AM (UTC)

@gitpod-io
Copy link

gitpod-io bot commented Jul 6, 2022

@github-actions
Copy link

This Pull Request has not seen any activity for the past 45 days. If this Pull Request would not see any further updates in the next 10 days, it would be automatically closed. Please tag a maintainer to have it reviewed and merged for you. We truly appreciate your contributions and would love to hear your thoughts on the same!

@github-actions
Copy link

github-actions bot commented Oct 9, 2022

Thanks for raising a Pull Request! We at moja global appreciate your contributions. We capitalize on fostering a welcoming environment for all our contributors. This Pull Request was closed because it has been stalled for 10 days with no activity. If you would like to discuss it further, please reach out to a maintainer to have it opened and reviewed. We truly appreciate your contributions and would love to hear your thoughts on the same!

@aornugent
Copy link

Nice one @Namyalg - sorry it's taken so long to review

Copy link

@sarahhaggarty sarahhaggarty left a comment

Choose a reason for hiding this comment

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

Nice one @Namyalg! I've made some suggestions to fix typos, missing full stops, and suggest different wording.

- Cloud\DevOps
---

FLINT Cloud is a project being developed to demonstrate the abilities of the [FLINT](https://docs.moja.global/en/master/FLINT/index.html) and its associated services on remote cloud resources. The project aims to build a continuous deployment pipeline to offer FLINT as a SaaS over cloud

Choose a reason for hiding this comment

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

Suggested change
FLINT Cloud is a project being developed to demonstrate the abilities of the [FLINT](https://docs.moja.global/en/master/FLINT/index.html) and its associated services on remote cloud resources. The project aims to build a continuous deployment pipeline to offer FLINT as a SaaS over cloud
FLINT Cloud is a project being developed to demonstrate the abilities of the [FLINT](https://docs.moja.global/en/master/FLINT/index.html) and its associated services on remote cloud resources. The project aims to build a continuous deployment pipeline that can offer FLINT as a SaaS over cloud.

---

FLINT Cloud is a project being developed to demonstrate the abilities of the [FLINT](https://docs.moja.global/en/master/FLINT/index.html) and its associated services on remote cloud resources. The project aims to build a continuous deployment pipeline to offer FLINT as a SaaS over cloud
It provides an abstraction of the underlying implementation while offering the users a simple way to understand the functionality of the FLINT

Choose a reason for hiding this comment

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

Suggested change
It provides an abstraction of the underlying implementation while offering the users a simple way to understand the functionality of the FLINT
It provides an abstraction of the underlying implementation while offering the users a simple way to understand the functionality of the FLINT.

It provides an abstraction of the underlying implementation while offering the users a simple way to understand the functionality of the FLINT

## Why is it needed?
- Today, remote cloud resources are extremely accessible. Providers like Amazon, Google, and Microsoft offer great flexibility and scalability. They also offer very generous free tiers, which will allow users to perform smaller runs.

Choose a reason for hiding this comment

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

Suggested change
- Today, remote cloud resources are extremely accessible. Providers like Amazon, Google, and Microsoft offer great flexibility and scalability. They also offer very generous free tiers, which will allow users to perform smaller runs.
- Today, remote cloud resources are extremely accessible. Providers like Amazon, Google, and Microsoft offer great flexibility and scalability. They also offer very generous free tiers that allow users to perform smaller runs.


## Why is it needed?
- Today, remote cloud resources are extremely accessible. Providers like Amazon, Google, and Microsoft offer great flexibility and scalability. They also offer very generous free tiers, which will allow users to perform smaller runs.
- Thus, in deploying the FLINT on remote cloud resources the main objective is to increase ease of use and reduce the dependency on local systems, configurations, etc

Choose a reason for hiding this comment

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

Suggested change
- Thus, in deploying the FLINT on remote cloud resources the main objective is to increase ease of use and reduce the dependency on local systems, configurations, etc
- Thus, in deploying the FLINT on remote cloud resources, the main objective is to increase ease of use and reduce the dependency on local systems, configurations, etc.

## Why is it needed?
- Today, remote cloud resources are extremely accessible. Providers like Amazon, Google, and Microsoft offer great flexibility and scalability. They also offer very generous free tiers, which will allow users to perform smaller runs.
- Thus, in deploying the FLINT on remote cloud resources the main objective is to increase ease of use and reduce the dependency on local systems, configurations, etc
- Developers experienced with the FLINTcloud framework will be able to support existing users with CI/CD pipelines, simplify model development and deployment, and leverage auto-scaling for large FLINT runs.

Choose a reason for hiding this comment

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

Suggested change
- Developers experienced with the FLINTcloud framework will be able to support existing users with CI/CD pipelines, simplify model development and deployment, and leverage auto-scaling for large FLINT runs.
- Developers who are already experienced with the FLINT cloud framework will be able to support existing users with building CI/CD pipelines, simplifying model development and deployment, and leveraging auto-scaling for large FLINT runs.


## Architecture

The FLINT is a CLI-based tool. In order to move it into a cloud-based environment, it is packaged into a web server making the use of RESTful API.

Choose a reason for hiding this comment

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

Suggested change
The FLINT is a CLI-based tool. In order to move it into a cloud-based environment, it is packaged into a web server making the use of RESTful API.
The FLINT is a CLI-based tool. In order to move it into a cloud-based environment, it is packaged into a web server by using RESTful API.


The FLINT is a CLI-based tool. In order to move it into a cloud-based environment, it is packaged into a web server making the use of RESTful API.

A wrapper REST API is created to provide the different endpoints which point to the different operations of the CLI tool. The functionality of the FLINT and GCBM examples are provided through REST APIs written in Flask.

Choose a reason for hiding this comment

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

Suggested change
A wrapper REST API is created to provide the different endpoints which point to the different operations of the CLI tool. The functionality of the FLINT and GCBM examples are provided through REST APIs written in Flask.
A wrapper REST API is created to provide the different endpoints that point to the different operations of the CLI tool. The functionality of the FLINT and GCBM examples are provided through REST APIs written in Flask.


## Significance of FLINT Cloud in the ecosystem

The development of the FLINT Cloud project has been instrumental in leading to the development of projects like [FLINT-UI](https://github.com/moja-global/FLINT-UI) and Data-driven integration with [CML and DVC](https://cml.dev/). The goal of DVC is to bring agility, reproducibility, and collaboration into existing data science workflows.

Choose a reason for hiding this comment

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

Suggested change
The development of the FLINT Cloud project has been instrumental in leading to the development of projects like [FLINT-UI](https://github.com/moja-global/FLINT-UI) and Data-driven integration with [CML and DVC](https://cml.dev/). The goal of DVC is to bring agility, reproducibility, and collaboration into existing data science workflows.
The development of the FLINT Cloud project has been instrumental in the development of projects like [FLINT-UI](https://github.com/moja-global/FLINT-UI) and data-driven integration with [Data version control (DVC) and software Continuous Machine Learning (CML)](https://cml.dev/). The goal of DVC is to bring agility, reproducibility, and collaboration into existing data science workflows.


The development of the FLINT Cloud project has been instrumental in leading to the development of projects like [FLINT-UI](https://github.com/moja-global/FLINT-UI) and Data-driven integration with [CML and DVC](https://cml.dev/). The goal of DVC is to bring agility, reproducibility, and collaboration into existing data science workflows.

FLINT-UI is a frontend interface written in Vue to interact with the FLINT Cloud APIs. This allows people from various technical and non-technical backgrounds to interact with the web application, run simulations and visualize results

Choose a reason for hiding this comment

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

Suggested change
FLINT-UI is a frontend interface written in Vue to interact with the FLINT Cloud APIs. This allows people from various technical and non-technical backgrounds to interact with the web application, run simulations and visualize results
FLINT-UI is a frontend interface written in Vue to interact with the FLINT Cloud APIs. This allows people from various technical and non-technical backgrounds to interact with the web application, run simulations and visualize results.

FLINT-UI is a frontend interface written in Vue to interact with the FLINT Cloud APIs. This allows people from various technical and non-technical backgrounds to interact with the web application, run simulations and visualize results

The second project is based on the concepts of reproducible science.
Data version control (DVC) and software Continuous Machine Learning (CML) provide a framework to continuously reproduce analyses using Github Actions as well as saving the output of the configuration phase to reuse for subsequent builds. The basic idea is to track the inputs provided to the model and monitor the outputs generated in various simulations over time. Though this feature isn’t natively required for the FLINT cloud project, it provides users with a way to incorporate them in their implementations.

Choose a reason for hiding this comment

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

Suggested change
Data version control (DVC) and software Continuous Machine Learning (CML) provide a framework to continuously reproduce analyses using Github Actions as well as saving the output of the configuration phase to reuse for subsequent builds. The basic idea is to track the inputs provided to the model and monitor the outputs generated in various simulations over time. Though this feature isn’t natively required for the FLINT cloud project, it provides users with a way to incorporate them in their implementations.
DVC and software CML provide a framework to continuously reproduce analyses using GitHub Actions as well as saving the output of the configuration phase for reuse in subsequent builds. The basic idea is to track the inputs provided to the model and monitor the outputs generated in various simulations over time. Though this feature isn’t natively required for the FLINT cloud project, it provides users with a way to incorporate them in their implementations.

@Namyalg
Copy link
Member Author

Namyalg commented Nov 26, 2022

Hey @sarahhaggarty
Thank you for the review, will make these changes

@github-actions
Copy link

This Pull Request has not seen any activity for the past 45 days. If this Pull Request would not see any further updates in the next 10 days, it would be automatically closed. Please tag a maintainer to have it reviewed and merged for you. We truly appreciate your contributions and would love to hear your thoughts on the same!

@HarshCasper
Copy link
Member

I will continue to work on this, and will possibly finish this by next weekend!

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.

Documentation: Case Study on FLINT Cloud
4 participants