ScholarlyInfrastructure


NameScholarlyInfrastructure JSON
Version 0.0.2 PyPI version JSON
download
home_pagehttps://github.com/THU-CVML/ScholarlyInfrastructure
Summary所谓大学者,非谓有大楼之谓也,有大师之谓也。
upload_time2024-11-16 09:04:26
maintainerNone
docs_urlNone
author叶璨铭 (Ye Canming)
requires_python>=3.7
licenseApache Software License 2.0
keywords nbdev jupyter notebook python thu tsinghua cv ml vision learning
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 大师荟萃之楼


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

> “所谓大学者,非谓有大楼之谓也,有大师之谓也。” ——梅贻琦

> “A first-class university is not top for its grand infrastuctures, but
> by its great scholars.” —— Mei Yiqi

Inspired by the timeless wisdom of Mei Yiqi, Scholarly Infrastructure is
a foundational library designed to support and accelerate research
projects within our laboratory.

## 🌟 Introduction

**Scholarly Infrastructure** aims to provide a robust and modular
foundation for all projects in our research group. It centralizes common
utilities, tools, and workflows, enabling seamless collaboration and
reducing redundant development effort. By building on this
infrastructure, researchers can focus more on innovation and
experimentation rather than re-implementing fundamental components.

## 🔑 **Key Features**

- 📚 **Common Utilities**: Ready-to-use tools for data processing,
  visualization, and analysis.  
- ⚙️ **Modular Design**: Highly reusable modules that can be integrated
  across diverse projects.  
- 🚀 **Performance Optimization**: Optimized algorithms and workflows
  for research tasks.  
- 🔒 **Scalable and Reliable**: Built to handle the increasing
  complexity of modern research.  
- 🛠️ **Customizable**: Easy to extend and tailor to specific project
  needs.

## 📦 **Installation**

Install latest from the GitHub
[repository](https://github.com/THU-CVML/ScholarlyInfrastructure):

``` sh
$ pip install git+https://github.com/THU-CVML/ScholarlyInfrastructure.git
```

or from [conda](https://anaconda.org/2catycm/namable_classify)

``` sh
$ conda install -c yecanming6666 scholarly_infrastructure
```

or from [pypi](https://pypi.org/project/namable_classify/)

``` sh
$ pip install scholarly_infrastructure
```

<!-- [docs]: https://2catycm.github.io/NamableClassify/ -->

## 📖 **Usage**

### Documentation

Documentation currently not available.

<!-- Documentation can be found hosted on this GitHub [repository][repo]'s [pages][docs].  -->
<!-- TODO correct links -->
<!-- [docs]: https://github.com/THU-CVML/ScholarlyInfrastructure -->

### Quick Start

Here’s a quick example to get started:

``` python
1+1
```

    2

<!-- ## 🏗️ **Architecture**
&#10;The library is organized into the following modules:
&#10;1. **Data Utilities**: Functions for data loading, cleaning, and manipulation.  
2. **Visualization Tools**: Easy-to-use tools for plotting and presenting data.  
3. **Model Training Helpers**: Scripts and utilities to streamline model training and evaluation.  
4. **Optimization Frameworks**: Support for hyperparameter tuning and experimentation.  
5. **Research Tools**: Domain-specific tools tailored to our lab's projects.
&#10;--- -->

## 🤝 **Contributing**

Contributions are welcome! Here’s how you can quickly get involved.
Please review our [contribution guidelines](CONTRIBUTING.md) for more
details.

### git guide

1.  Fork the repository and then git clone it to your local machine:
    `git clone https://github.com/your-username/ScholarlyInfrastructure.git`.  
2.  Create a new branch for your feature or bug fix:
    `git checkout -b feature-name`.  
3.  Commit your changes: `git commit -m "Add feature-name"`.  
4.  Push your branch: `git push origin feature-name`.  
5.  Open a pull request and describe your changes.

------------------------------------------------------------------------

### nbdev framework guide

Our project utilizes `nbdev` to manage our codes, tests and
documentation. If you are new to using `nbdev` here are some quich
points to get you started.

#### 1. Install this libary in Development mode

After you have cloned the repository, and before you start working on
it, you need to pip install this library in development mode. This can
be done using the following command:

``` sh
# make sure NamableClassify package is installed in development mode
$ pip install -e .[dev]
```

#### 2. make changes under `notebooks/` directory

use `#| export` for exported codes.

#### 3. check and synchronize before git commit

``` sh
# compile to have changes apply to the python module
$ nbdev_prepare
```

## 📜 **License**

This project is licensed under the [Apache 2.0 License](LICENSE). You
are free to use, modify, and distribute this software under the terms,
provided you comply with the license’s conditions, including giving
credit to the original authors and not using their trademarks.

<!-- TODO contributors authors in a file -->
<!-- ---
&#10;## 🌐 **Contact**
&#10;For questions, feedback, or support, feel free to reach out:
&#10;- **Maintainer**: Your Name  
- **Email**: your_email@example.com  
- **Website**: [Your Lab's Website](https://example.com)
&#10;--- -->

Let **Scholarly Infrastructure** be the foundation that powers your next
groundbreaking discovery. Together, we build not just tools, but a
thriving research ecosystem. ✨

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/THU-CVML/ScholarlyInfrastructure",
    "name": "ScholarlyInfrastructure",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "nbdev jupyter notebook python thu tsinghua cv ml vision learning",
    "author": "\u53f6\u74a8\u94ed (Ye Canming)",
    "author_email": "ycm24@mails.tsinghua.edu.cn",
    "download_url": "https://files.pythonhosted.org/packages/cd/c1/19375f22ab287f25d27c5ced8e074bf10e573e37365807766a9df95c79dc/scholarlyinfrastructure-0.0.2.tar.gz",
    "platform": null,
    "description": "# \u5927\u5e08\u835f\u8403\u4e4b\u697c\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n> \u201c\u6240\u8c13\u5927\u5b66\u8005\uff0c\u975e\u8c13\u6709\u5927\u697c\u4e4b\u8c13\u4e5f\uff0c\u6709\u5927\u5e08\u4e4b\u8c13\u4e5f\u3002\u201d \u2014\u2014\u6885\u8d3b\u7426\n\n> \u201cA first-class university is not top for its grand infrastuctures, but\n> by its great scholars.\u201d \u2014\u2014 Mei Yiqi\n\nInspired by the timeless wisdom of Mei Yiqi, Scholarly Infrastructure is\na foundational library designed to support and accelerate research\nprojects within our laboratory.\n\n## \ud83c\udf1f Introduction\n\n**Scholarly Infrastructure** aims to provide a robust and modular\nfoundation for all projects in our research group. It centralizes common\nutilities, tools, and workflows, enabling seamless collaboration and\nreducing redundant development effort. By building on this\ninfrastructure, researchers can focus more on innovation and\nexperimentation rather than re-implementing fundamental components.\n\n## \ud83d\udd11 **Key Features**\n\n- \ud83d\udcda **Common Utilities**: Ready-to-use tools for data processing,\n  visualization, and analysis.  \n- \u2699\ufe0f **Modular Design**: Highly reusable modules that can be integrated\n  across diverse projects.  \n- \ud83d\ude80 **Performance Optimization**: Optimized algorithms and workflows\n  for research tasks.  \n- \ud83d\udd12 **Scalable and Reliable**: Built to handle the increasing\n  complexity of modern research.  \n- \ud83d\udee0\ufe0f **Customizable**: Easy to extend and tailor to specific project\n  needs.\n\n## \ud83d\udce6 **Installation**\n\nInstall latest from the GitHub\n[repository](https://github.com/THU-CVML/ScholarlyInfrastructure):\n\n``` sh\n$ pip install git+https://github.com/THU-CVML/ScholarlyInfrastructure.git\n```\n\nor from [conda](https://anaconda.org/2catycm/namable_classify)\n\n``` sh\n$ conda install -c yecanming6666 scholarly_infrastructure\n```\n\nor from [pypi](https://pypi.org/project/namable_classify/)\n\n``` sh\n$ pip install scholarly_infrastructure\n```\n\n<!-- [docs]: https://2catycm.github.io/NamableClassify/ -->\n\n## \ud83d\udcd6 **Usage**\n\n### Documentation\n\nDocumentation currently not available.\n\n<!-- Documentation can be found hosted on this GitHub [repository][repo]'s [pages][docs].  -->\n<!-- TODO correct links -->\n<!-- [docs]: https://github.com/THU-CVML/ScholarlyInfrastructure -->\n\n### Quick Start\n\nHere\u2019s a quick example to get started:\n\n``` python\n1+1\n```\n\n    2\n\n<!-- ## \ud83c\udfd7\ufe0f **Architecture**\n&#10;The library is organized into the following modules:\n&#10;1. **Data Utilities**: Functions for data loading, cleaning, and manipulation.  \n2. **Visualization Tools**: Easy-to-use tools for plotting and presenting data.  \n3. **Model Training Helpers**: Scripts and utilities to streamline model training and evaluation.  \n4. **Optimization Frameworks**: Support for hyperparameter tuning and experimentation.  \n5. **Research Tools**: Domain-specific tools tailored to our lab's projects.\n&#10;--- -->\n\n## \ud83e\udd1d **Contributing**\n\nContributions are welcome! Here\u2019s how you can quickly get involved.\nPlease review our [contribution guidelines](CONTRIBUTING.md) for more\ndetails.\n\n### git guide\n\n1.  Fork the repository and then git clone it to your local machine:\n    `git clone https://github.com/your-username/ScholarlyInfrastructure.git`.  \n2.  Create a new branch for your feature or bug fix:\n    `git checkout -b feature-name`.  \n3.  Commit your changes: `git commit -m \"Add feature-name\"`.  \n4.  Push your branch: `git push origin feature-name`.  \n5.  Open a pull request and describe your changes.\n\n------------------------------------------------------------------------\n\n### nbdev framework guide\n\nOur project utilizes `nbdev` to manage our codes, tests and\ndocumentation. If you are new to using `nbdev` here are some quich\npoints to get you started.\n\n#### 1. Install this libary in Development mode\n\nAfter you have cloned the repository, and before you start working on\nit, you need to pip install this library in development mode. This can\nbe done using the following command:\n\n``` sh\n# make sure NamableClassify package is installed in development mode\n$ pip install -e .[dev]\n```\n\n#### 2. make changes under `notebooks/` directory\n\nuse `#| export` for exported codes.\n\n#### 3. check and synchronize before git commit\n\n``` sh\n# compile to have changes apply to the python module\n$ nbdev_prepare\n```\n\n## \ud83d\udcdc **License**\n\nThis project is licensed under the [Apache 2.0 License](LICENSE). You\nare free to use, modify, and distribute this software under the terms,\nprovided you comply with the license\u2019s conditions, including giving\ncredit to the original authors and not using their trademarks.\n\n<!-- TODO contributors authors in a file -->\n<!-- ---\n&#10;## \ud83c\udf10 **Contact**\n&#10;For questions, feedback, or support, feel free to reach out:\n&#10;- **Maintainer**: Your Name  \n- **Email**: your_email@example.com  \n- **Website**: [Your Lab's Website](https://example.com)\n&#10;--- -->\n\nLet **Scholarly Infrastructure** be the foundation that powers your next\ngroundbreaking discovery. Together, we build not just tools, but a\nthriving research ecosystem. \u2728\n",
    "bugtrack_url": null,
    "license": "Apache Software License 2.0",
    "summary": "\u6240\u8c13\u5927\u5b66\u8005\uff0c\u975e\u8c13\u6709\u5927\u697c\u4e4b\u8c13\u4e5f\uff0c\u6709\u5927\u5e08\u4e4b\u8c13\u4e5f\u3002",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/THU-CVML/ScholarlyInfrastructure"
    },
    "split_keywords": [
        "nbdev",
        "jupyter",
        "notebook",
        "python",
        "thu",
        "tsinghua",
        "cv",
        "ml",
        "vision",
        "learning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0ba9abc9c26d214a9d79daa95cdb9771bc48dac51e41170f03af7d783dd93dae",
                "md5": "72e21729637eb249c90fd2a794a373c8",
                "sha256": "0eb996a0ced3a1efc88b2791c2c86fed2b06e0ba49cd3fcf6ead3bf2dddc45bd"
            },
            "downloads": -1,
            "filename": "ScholarlyInfrastructure-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "72e21729637eb249c90fd2a794a373c8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 24032,
            "upload_time": "2024-11-16T09:04:25",
            "upload_time_iso_8601": "2024-11-16T09:04:25.309523Z",
            "url": "https://files.pythonhosted.org/packages/0b/a9/abc9c26d214a9d79daa95cdb9771bc48dac51e41170f03af7d783dd93dae/ScholarlyInfrastructure-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cdc119375f22ab287f25d27c5ced8e074bf10e573e37365807766a9df95c79dc",
                "md5": "74fa8fe106f259d63f90e876ad056f85",
                "sha256": "ac4b144a258b5807c71af58c504ae4cd3df09d44519f0b4100c2f01bcd510df5"
            },
            "downloads": -1,
            "filename": "scholarlyinfrastructure-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "74fa8fe106f259d63f90e876ad056f85",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 18439,
            "upload_time": "2024-11-16T09:04:26",
            "upload_time_iso_8601": "2024-11-16T09:04:26.751146Z",
            "url": "https://files.pythonhosted.org/packages/cd/c1/19375f22ab287f25d27c5ced8e074bf10e573e37365807766a9df95c79dc/scholarlyinfrastructure-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-16 09:04:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "THU-CVML",
    "github_project": "ScholarlyInfrastructure",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "scholarlyinfrastructure"
}
        
Elapsed time: 0.47363s