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

Created FAQ.md #131

Merged
merged 5 commits into from
Jul 26, 2023
Merged

Created FAQ.md #131

merged 5 commits into from
Jul 26, 2023

Conversation

neelimagoogly
Copy link
Contributor

I have created FAQs for fAIr wrt issue #128 . @kshitijrajsharma , @omranlm and @petya-kangalova please review it.

docs/FAQ.md Outdated

**Q : How can I use fAIr in my mapping projects?**

A : To use fAIr, you can follow the installation instructions provided in the documentation. Once installed, you can utilize the pre-trained AI models for tasks such as road network extraction, building footprint detection, or land use classification. The documentation offers examples and guidelines to help you get started.
Copy link
Member

Choose a reason for hiding this comment

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

Add a clause here , Building for now

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

docs/FAQ.md Outdated

**Q : What types of data can I use with fAIr?**

A : fAIr primarily works with satellite imagery and aerial photographs. You can use various types of imagery sources, including public satellite imagery datasets, to perform mapping tasks using the AI models provided. The documentation provides information on the compatible data formats and recommended data sources.
Copy link
Member

Choose a reason for hiding this comment

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

Various source of imagery which compiles with opensource imagery license

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

docs/FAQ.md Outdated

**Q : Can I integrate fAIr with other mapping tools or platforms?**

A : Yes, fAIr is designed to be modular and can be integrated into existing mapping workflows and platforms. It provides interoperability with tools like OpenStreetMap, QGIS, and ArcGIS. You can leverage the AI models from fAIr within these tools or use the outputs of fAIr in combination with other mapping datasets and tools.
Copy link
Member

Choose a reason for hiding this comment

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

It provides modular pip packages/ API endpoints that can be used in other scripts and can be integrated as plugins on different platforms such as Qgis, Josm etc

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

docs/FAQ.md Outdated Show resolved Hide resolved
docs/FAQ.md Outdated

**Q : Can I propose new AI models or enhancements to existing models?**

A : Absolutely! The fAIr project welcomes contributions related to new AI models or enhancements to existing models. If you have developed a new model that aligns with the project's goals or if you have ideas to improve the current models, you can propose them through the GitHub repository and engage in discussions with the community or you can create them at [here](https://fair-dev.hotosm.org/ai-models) .
Copy link
Member

Choose a reason for hiding this comment

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

Advised to Remove last or part , once approved community will be able go use it , link them to fAIr-utilities

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed the last or part . But I am unable to get the fAIr utilities.

Copy link
Contributor

Choose a reason for hiding this comment

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

@neelimagoogly fAIr repo is the one handing backend and frontend components .. However, the backend is using s separate library we call it fAIr-utilities to handle:

  1. Data preparation for the models
  2. models trainings
  3. inference process
  4. post processing (converting the predicted features to geo data)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @omranlm . I have made the change and linked it to fAIr utilities.

@neelimagoogly neelimagoogly added documentation Improvements or additions to documentation Outreachy Project tasks for Outreachy internship - May to August 2023 labels Jul 13, 2023
@neelimagoogly neelimagoogly self-assigned this Jul 13, 2023
@neelimagoogly
Copy link
Contributor Author

@kshitijrajsharma and @omranlm , I have made the suggested changes and it is ready to merge now . Please review it and merge it if possible.

@kshitijrajsharma
Copy link
Member

This PR has also changes for Readme , I guess it was based on previous branch ? @neelimagoogly

@neelimagoogly
Copy link
Contributor Author

This PR has also changes for Readme , I guess it was based on previous branch ? @neelimagoogly

Yes , this PR contains the updated frontend Readme according to PR #134 which you had merged last week . The changes that were made in that PR are reflected here.

@kshitijrajsharma kshitijrajsharma merged commit 1b8a94a into master Jul 26, 2023
2 checks passed
@kshitijrajsharma kshitijrajsharma deleted the neelimagoogly-patch-1 branch July 26, 2023 02:50
jeafreezy pushed a commit to jeafreezy/fAIr that referenced this pull request Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Outreachy Project tasks for Outreachy internship - May to August 2023
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants