diff --git a/README.md b/README.md index fb4f3b4..52af946 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,30 @@ # Manolia + +![Manolia logo](./doc/manolia.png?raw=true) + https://www.manolia.org/ +## About The Project + +Manolia provides a knowledge layer for Natural Language Processing, centered on commons-based peer production and sustainability. It serves as an intermediary layer between collective knowledge system and lightweight, open-source NLP tools, designed to process raw and unstructured knowledge into structured, well-designed formats for collaborative work. This enables the creation of effective digital commons. The system is aimed at communities that prioritize privacy and sustainability and requires small-scale and quality automation of knowledge processing. + +## Built With + +UI: Vue.js +Server: FastAPI + +## Small Language Model + +Inference Engine: llama.cpp +Model: SmolLM3 +Hardware tested : CPU Intel Xeon E5430 + # Alpha -To test Manolia principles. \ No newline at end of file +At this early stage, Manolia is an annotation application. It enables data to be collected on users’ perceptions of the quality of the questions generated from a paragraph of knowledge entered by the user. + +# Beta + +Objective: To build an API server containing a complete pipeline. + +![Component diagram](./doc/component_diagram.png?raw=true "Component diagram") +![NLP pipeline](./doc/nlp_pipeline.png?raw=true "NLP pipeline") \ No newline at end of file diff --git a/doc/component_diagram.png b/doc/component_diagram.png new file mode 100644 index 0000000..9645a75 Binary files /dev/null and b/doc/component_diagram.png differ diff --git a/doc/manolia.png b/doc/manolia.png new file mode 100644 index 0000000..5693e5e Binary files /dev/null and b/doc/manolia.png differ diff --git a/doc/nlp_pipeline.png b/doc/nlp_pipeline.png new file mode 100644 index 0000000..06bdcc5 Binary files /dev/null and b/doc/nlp_pipeline.png differ diff --git a/server/README.md b/server/README.md deleted file mode 100644 index 776a87c..0000000 --- a/server/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# Server -FastAPI server to run Manolia - -# Run -``` -cd src/app -fastapi dev main.py -``` - -# Best Practice - -**To alpha-2 switch to** -## SQLEModel-boilerplate -https://github.com/benavlabs/SQLModel-boilerplate/tree/main - ------ - -## Simple Boilerplate -https://github.com/anthonycepeda/fastapi-sqlmodel/tree/main - -## Global Boilerplate -https://github.com/zhanymkanov/fastapi-best-practices?tab=readme-ov-file#excessively-use-pydantic - - diff --git a/user-interface/README.md b/user-interface/README.md deleted file mode 100644 index f4c9dfc..0000000 --- a/user-interface/README.md +++ /dev/null @@ -1,70 +0,0 @@ -# user-interface - -This template should help get you started developing with Vue 3 in Vite. - -## Recommended IDE Setup - -[VS Code](https://code.visualstudio.com/) + [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). - -## Recommended Browser Setup - -- Chromium-based browsers (Chrome, Edge, Brave, etc.): - - [Vue.js devtools](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd) - - [Turn on Custom Object Formatter in Chrome DevTools](http://bit.ly/object-formatters) -- Firefox: - - [Vue.js devtools](https://addons.mozilla.org/en-US/firefox/addon/vue-js-devtools/) - - [Turn on Custom Object Formatter in Firefox DevTools](https://fxdx.dev/firefox-devtools-custom-object-formatters/) - -## Type Support for `.vue` Imports in TS - -TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types. - -## Customize configuration - -See [Vite Configuration Reference](https://vite.dev/config/). - -## Project Setup - -```sh -npm install -``` - -### Compile and Hot-Reload for Development - -```sh -npm run dev -``` - -### Type-Check, Compile and Minify for Production - -```sh -npm run build -``` - -### Run Unit Tests with [Vitest](https://vitest.dev/) - -```sh -npm run test:unit -``` - -### Run End-to-End Tests with [Cypress](https://www.cypress.io/) - -```sh -npm run test:e2e:dev -``` - -This runs the end-to-end tests against the Vite development server. -It is much faster than the production build. - -But it's still recommended to test the production build with `test:e2e` before deploying (e.g. in CI environments): - -```sh -npm run build -npm run test:e2e -``` - -### Lint with [ESLint](https://eslint.org/) - -```sh -npm run lint -```