Skip to content

Docs: homepage, Team/License pages, user guide & README updates, feature-focused #17

Merged
AhmedRadwan02 merged 11 commits intomainfrom
unbias-pretrained
Mar 4, 2026
Merged

Docs: homepage, Team/License pages, user guide & README updates, feature-focused #17
AhmedRadwan02 merged 11 commits intomainfrom
unbias-pretrained

Conversation

@AhmedRadwan02
Copy link
Collaborator

Summary

Documentation updates:

  • Docs homepage: FairSense-style landing with PyPI badge, Colab link, two demo UI videos (silent/voiced), Highlights (detection, classification, reasoning, debiasing), Quick start, and Contents.
  • New pages: Team (contributors, acknowledgement, support) and License (Apache 2.0).
  • User guide: Default model set to vector-institute/Unbias-plus-Qwen2.5, serve/demo UI and Python API examples updated, dev port note for MkDocs.
  • README & copy: De-emphasised "single model"; refocused on features (bias detection, classification, reasoning, debiasing, structured output). Same messaging in docs/index.md, pyproject.toml description, and FastAPI app description.
  • API reference: Short intro added to api.md.
  • Nav: Team and License added to MkDocs nav and index Contents.

Clickup Ticket(s): Link if applicable.

Type of Change

  • ✨ New feature (non-breaking change that adds functionality)

Changes Made

  • New docs homepage (index.md): PyPI/Colab/video links, Highlights (detection, classification, reasoning, debiasing), Quick start, Contents
  • New pages: team.md (Team, Acknowledgement, Support), license.md (Apache 2.0)
  • User guide: default model vector-institute/Unbias-plus-Qwen2.5, updated serve/Python examples, MkDocs port note
  • README, index.md, pyproject.toml, api.py: feature-focused copy; removed “single model” emphasis
  • api.md: short intro paragraph
  • mkdocs.yml: nav entries for Team and License; index.md Contents links to both

Testing

  • Tests pass locally (uv run pytest tests/)

Checklist

  • Code follows the project's style guidelines
  • Self-review of code completed
  • Documentation updated (if applicable)
  • No sensitive information (API keys, credentials) exposed

@AhmedRadwan02 AhmedRadwan02 merged commit 42a3f3d into main Mar 4, 2026
5 checks passed
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.

1 participant