Skip to content

Commit

Permalink
Add pages on motivation to use Imageomics Org repos (#10)
Browse files Browse the repository at this point in the history
* Add pages on motivation to use Imageomics Org repos

Co-authored-by: Matt Thompson <[email protected]>

Co-authored-by: Zoe Duan <[email protected]>

* Remove question mark from page names

* Fix nav to 'why use' pages

---------

Co-authored-by: Zoe Duan <[email protected]>
Co-authored-by: Matt Thompson <[email protected]>
  • Loading branch information
3 people authored Nov 20, 2024
1 parent 7ddb995 commit 2022123
Show file tree
Hide file tree
Showing 3 changed files with 105 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/wiki-guide/Why-use-the-Institute-GitHub.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# _"Why should I put my work into the Imageomics GitHub org,"_ you ask?

The [Imageomics GitHub organization](https://github.com/Imageomics) exists to facilitate collaboration and version control among team members working on projects within the institute and make them available to the research community. You are encouraged to take advantage of the benefits of using this GitHub organization for your institute projects!

## Centralization

This is the main aspect that leads to other benefits. Whether you are running your code on your own computer, a GPU server, a supercomputing cluster, AWS, or the Matrix, maintaining a git repository of this code hosted on the institute GitHub org keeps everyone's work that is otherwise scattered around in a single place. Some of the benefits derived from this are ...

### Collaboration

- You know where your team's work is, and your team knows where your work is.
- Code is simpler to find, share, access, review, and manage.
- Access privileges can be granted and managed through [teams](https://github.com/orgs/Imageomics/teams), which Institute staff can administer for you, rather than access having to be managed on a per-individual basis.
- Progress can be communicated readily, and help can be solicited when needed, including through [teams](https://github.com/orgs/Imageomics/teams).

### Knowledge Sharing

- Projects documented by a well-written README file are much more accessible than combing through old Zoom recordings to find out or remember what someone else is working on.
- When new members join, they can get up-to-speed quickly.
- When members move on to new roles, their work is preserved and more easily continued and built upon.
- Good practices can diffuse through and between teams more quickly.
- These points enhance the research capacity and productivity of individuals as well as the overall institute.

### Visibility + Impact

- Work hosted under the Imageomics GitHub organization is directly associated with and contributes to the institute's brand, showcasing the collective contributions of our teams and enhancing the visibility and impact of their work within the broader community.
- Your profile is featured alongside repositories you contribute to, providing opportunities for networking with those who find your work valuable.


## Professional Development

Despite its rough edges, the common standard for version control and code management is git. You'll get a competitive edge with experience using it on a team to collaborate.

## Showcasing Your Work

If you want your public work with Imageomics featured on your personal GitHub profile, you can make use of the GitHub [pin](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile) feature to have public repositories of your choice appear at the top of your profile whether they belong to you through an organization or personally.

## Flexibility

While we encourage you to host your institute-related work on the Imageomics GitHub organization to maximize these benefits, we understand that there may be situations where other platforms or private repositories are more appropriate. These include:

- Personal projects or work not directly tied to the institute.
- Projects developed prior to joining the institute where transferring ownership might be complex or undesirable.

We strongly encourage you to keep your institute-related work centrally organized in the Imageomics GitHub organization to maximize the benefits for you and your fellow researchers!
58 changes: 58 additions & 0 deletions docs/wiki-guide/Why-use-the-Institute-Hugging-Face.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# _"Why should I put my work into the Imageomics Hugging Face org,"_ you ask?

The [Imageomics Hugging Face organization](https://huggingface.co/imageomics) is a crucial resource for facilitating collaboration, sharing models, and enhancing the accessibility of our AI and machine learning projects. By utilizing the Imageomics Hugging Face organization, you can take full advantage of the following benefits:

## Centralization

Centralizing our models and datasets on the Imageomics Hugging Face organization ensures that all team members have a reliable source for the tools and resources they need. It helps to:

- Keep everyone's work in a unified location, making it easier to manage and access.
- Ensure consistency and reliability in the models and datasets used across different projects.

## Collaboration

Hugging Face provides robust tools for collaborative development, making it easier to:

- Share models and datasets with your team and the wider research community.
- Contribute to and improve upon the work of others.
- Manage access through well-defined team structures, ensuring that the right people have the right permissions.
- Request and provide feedback through integrated commenting and discussion features.

## Knowledge Sharing

By hosting models and datasets on Hugging Face, we enhance knowledge sharing within and beyond the institute. This includes:

- Providing clear documentation and usage examples, making it easier for new members to get up to speed.
- Facilitating the spread of best practices across teams and projects.

## Visibility + Impact

Work hosted on the Imageomics Hugging Face organization benefits from increased visibility and impact:

- Models and datasets are directly associated with the Imageomics brand, showcasing our collective contributions.
- Your contributions are highlighted on your profile, enhancing your professional reputation and networking opportunities.
- High-quality, well-documented models and datasets can attract attention from the broader research community, leading to greater impact and potential collaborations.

## Professional Development

Using Hugging Face provides valuable experience with tools and practices that are widely recognized in the AI and machine learning communities. This includes:

- Hands-on experience with state-of-the-art model hosting and deployment tools.
- Opportunities to learn and implement best practices in model management and version control.

## Showcasing Your Work

Hugging Face offers several features to help you showcase your work:

- You can highlight your contributions by pinning repositories to your profile, making your most significant work easily accessible.
- Public models and datasets associated with the Imageomics organization can be featured on both your personal and the institute's profiles.

## Flexibility

While we encourage you to host your institute-related work on the Imageomics Hugging Face organization to maximize these benefits, we understand that there may be situations where other platforms or private repositories are more appropriate. These include:

- Personal projects or work not directly tied to the institute.
- Projects developed prior to joining the institute where transferring ownership might be complex or undesirable.


We strongly encourage you to leverage the Imageomics Hugging Face organization for your institute-related projects. This will help you and your fellow researchers maximize collaboration, knowledge sharing, and the overall impact of our collective work.
2 changes: 2 additions & 0 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,12 @@ nav:
- "Projects Guide": wiki-guide/Guide-to-GitHub-Projects.md
- "Branch Protections": wiki-guide/When-to-think-about-branch-protections.md
- "Two Repo Problem": wiki-guide/Two-Repo-Problem.md
- "Why Use the Institute GitHub": wiki-guide/Why-use-the-Institute-GitHub.md
- Hugging Face Guide:
- "Repo Guide": wiki-guide/Hugging-Face-Repo-Guide.md
- "Workflow": wiki-guide/The-Hugging-Face-Workflow.md
- "Dataset Upload Guide": wiki-guide/The-Hugging-Face-Dataset-Upload-Guide.md
- "Why Use the Institute Hugging Face": wiki-guide/Why-use-the-Institute-Hugging-Face.md
- Metadata Guide: wiki-guide/Metadata-Guide.md
- Templates:
- "Dataset Card Template": wiki-guide/HF_DatasetCard_Template_mkdocs.md
Expand Down

0 comments on commit 2022123

Please sign in to comment.