Created FAQ.md #131
Created FAQ.md #131
Conversation
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. |
There was a problem hiding this comment.
Add a clause here , Building for now
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. |
There was a problem hiding this comment.
Various source of imagery which compiles with opensource imagery license
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. |
There was a problem hiding this comment.
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
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) . |
There was a problem hiding this comment.
Advised to Remove last or part , once approved community will be able go use it , link them to fAIr-utilities
There was a problem hiding this comment.
Removed the last or part . But I am unable to get the fAIr utilities.
There was a problem hiding this comment.
@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:
- Data preparation for the models
- models trainings
- inference process
- post processing (converting the predicted features to geo data)
There was a problem hiding this comment.
Thanks @omranlm . I have made the change and linked it to fAIr utilities.
neelimagoogly
added
documentation
|
@kshitijrajsharma and @omranlm , I have made the suggested changes and it is ready to merge now . Please review it and merge it if possible. |
|
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. |
I have created FAQs for fAIr wrt issue #128 . @kshitijrajsharma , @omranlm and @petya-kangalova please review it.