Skip to content

external_sources.md

Latest commit

 

History

History
312 lines (246 loc) · 11.1 KB

external_sources.md

File metadata and controls

312 lines (246 loc) · 11.1 KB

External Sources and References

Document Version: 1.0.0
Last Updated: 2024-09-21
Review Date: 2024-12-21
Maintained By: SpiralGang Development Team

📋 Document Purpose

This document provides comprehensive attribution, licensing information, and references for all external sources, libraries, frameworks, and resources used in the VARIABOT project. Proper attribution ensures compliance with open-source licenses and intellectual property requirements.

🏷️ Primary Technology Stack

Core Dependencies

HuggingFace Ecosystem

  • HuggingFace Hub - Model hosting and API access

  • Gradio Client - Model interface client

    • Repository: https://github.com/gradio-app/gradio
    • License: Apache License 2.0
    • Version: 0.16.0
    • Usage: Remote model interaction and API calls
    • Citation: Abid, A., Abdalla, A., Abid, A., Khan, D., Alfozan, A., & Zou, J. (2019). Gradio: Hassle-free sharing and testing of ML models in the web. arXiv preprint arXiv:1906.02569.

Web Framework

  • Streamlit - Web application framework

AI Model Sources

Qwen Model Family

  • Qwen1.5-110B-Chat

    • Provider: Alibaba Cloud
    • HuggingFace: https://huggingface.co/Qwen/Qwen1.5-110B-Chat-demo
    • License: Custom License (see model page)
    • Paper: Bai, J., et al. (2023). Qwen Technical Report. arXiv preprint arXiv:2309.16609.
    • Usage: Large language model for chat interactions

  • Qwen1.5-MoE-A2.7B-Chat

Microsoft Phi-3 Models

  • Phi-3-mini-128k-instruct
    • Provider: Microsoft Research
    • HuggingFace: https://huggingface.co/eswardivi/Phi-3-mini-128k-instruct
    • License: MIT License
    • Paper: Abdin, M., et al. (2024). Phi-3 Technical Report: A Highly Capable Language Model Locally on Your Phone. arXiv preprint arXiv:2404.14219.
    • Context Length: 128,000 tokens
    • Usage: Compact model for resource-constrained environments

Apple OpenELM Models

  • OpenELM-3B
    • Provider: Apple Inc.
    • HuggingFace: https://huggingface.co/Norod78/OpenELM_3B_Demo
    • License: Apple Sample Code License
    • Paper: Mehta, S., et al. (2024). OpenELM: An Efficient Language Model Family with Open-source Training and Inference Framework. arXiv preprint arXiv:2404.14619.
    • Usage: Efficient language model with optimized architecture

📚 Academic References

Foundational Papers

Transformer Architecture

@article{vaswani2017attention,
  title={Attention is all you need},
  author={Vaswani, Ashish and Shazeer, Noam and Parmar, Niki and Uszkoreit, Jakob and Jones, Llion and Gomez, Aidan N and Kaiser, {\L}ukasz and Polosukhin, Illia},
  journal={Advances in neural information processing systems},
  volume={30},
  year={2017},
  url={https://arxiv.org/abs/1706.03762}
}

Large Language Models

@article{brown2020language,
  title={Language models are few-shot learners},
  author={Brown, Tom and Mann, Benjamin and Ryder, Nick and Subbiah, Melanie and Kaplan, Jared D and Dhariwal, Prafulla and Neelakantan, Arvind and Shyam, Pranav and Sastry, Girish and Askell, Amanda and others},
  journal={Advances in neural information processing systems},
  volume={33},
  pages={1877--1901},
  year={2020},
  url={https://arxiv.org/abs/2005.14165}
}

Mixture of Experts

@article{fedus2022switch,
  title={Switch transformer: Scaling to trillion parameter models with simple and efficient sparsity},
  author={Fedus, William and Zoph, Barret and Shazeer, Noam},
  journal={Journal of Machine Learning Research},
  volume={23},
  number={120},
  pages={1--39},
  year={2022},
  url={https://arxiv.org/abs/2101.03961}
}

🛠️ Development Tools and Libraries

Python Ecosystem

  • Python - Programming language
    • Version: 3.8+
    • License: Python Software Foundation License
    • URL: https://www.python.org/
    • Usage: Core programming language

Code Quality Tools

Testing Framework

🎨 Visual Assets and Media

Logos and Images

  • Qwen Logo - qwen100logo.png, qwenMoElogo.png

    • Source: Alibaba Cloud official assets
    • Usage: Model identification in UI
    • License: Used with permission for educational/research purposes

  • Phi-3 Logo - Phi3mini128-logo.png

    • Source: Microsoft official assets
    • Usage: Model identification in UI
    • License: Used under Microsoft brand guidelines

  • OpenELM Logo - OpenELMlogo.png

    • Source: Apple official assets
    • Usage: Model identification in UI
    • License: Used under Apple brand guidelines

Demo Media

  • GIF Demonstrations - Various .gif files
    • Creator: VARIABOT development team
    • License: MIT License (same as project)
    • Purpose: Usage demonstrations and documentation

🌐 External APIs and Services

HuggingFace Inference API

Model Hosting Spaces

  • Qwen Spaces:

    • Qwen/Qwen1.5-110B-Chat-demo
    • Qwen/qwen1.5-MoE-A2.7B-Chat-demo

  • Phi-3 Spaces:

    • eswardivi/Phi-3-mini-128k-instruct

  • OpenELM Spaces:

    • Norod78/OpenELM_3B_Demo

📄 Documentation Sources

Technical Documentation

Best Practices References

🔒 Security and Compliance References

Security Standards

Privacy Regulations

  • GDPR - General Data Protection Regulation

  • CCPA - California Consumer Privacy Act

🏢 Industry Standards and Frameworks

Software Development

  • ISO/IEC 25010 - Systems and software Quality Requirements and Evaluation (SQuaRE)
  • IEEE 829 - Standard for Software and System Test Documentation
  • ISO/IEC 27001 - Information Security Management Systems

AI/ML Standards

  • ISO/IEC 23053 - Framework for AI risk management
  • IEEE 2857 - Privacy engineering for software and systems
  • ISO/IEC 23094 - Artificial Intelligence Risk Management

📊 Data Sources and Datasets

Training Data References

Note: Specific training data for external models is not directly used by VARIABOT, but the following references provide context:

🤝 Community and Support

Development Communities

Support Channels

📝 Attribution Format

Code Attribution

When using external code snippets or adapting implementations:

# Adapted from: [Source URL]
# Original Author: [Author Name]
# License: [License Type]
# Modifications: [Description of changes made]

Model Attribution

When using AI model outputs:

# Model: [Model Name] by [Provider]
# Version: [Model Version]
# License: [Model License]
# Accessed: [Date]

🔄 Maintenance and Updates

Update Schedule

  • Monthly: Dependency version checks
  • Quarterly: License compliance review
  • Annually: Comprehensive attribution audit

Change Management

  • All new dependencies must be approved and documented
  • License changes require legal review
  • Attribution updates tracked in audit trail

Compliance Monitoring

  • Automated license scanning in CI/CD pipeline
  • Regular audits of external resource usage
  • Legal review for commercial deployment

📞 Contact Information

Legal and Compliance

  • Legal Team: [Contact via project maintainers]
  • Compliance Officer: [Contact via project maintainers]
  • Open Source Coordinator: [Contact via project maintainers]

Technical Questions

Disclaimer: This document represents our best effort to provide accurate attribution and licensing information. If you believe any attribution is incorrect or missing, please contact the project maintainers immediately for correction.

Legal Notice: Use of external models and services is subject to their respective terms of service and licensing agreements. Users are responsible for ensuring compliance with all applicable terms when deploying VARIABOT in their environment.